Skip to main content

Namespace.typings

Enumerations​

APP_EVENTS​

Enumeration Members​

Enumeration MemberValue
INFO_READY"#integration#ReleaseInfoReady"
REMOVED"#integration#Removed"
TOGGLE_STATUS"#integration#ToggleStatus"
UPDATE_CONFIG"#integration#UpdateConfig"
UPDATE_VERSION"#integration#UpdateVersion"

AUTH_EVENTS​

Enumeration Members​

Enumeration MemberValue
CONNECT_ADDRESS"#auth#connectAddress"
CONNECT_ADDRESS_SUCCESS"#auth#connectAddress#success"
MARK_MSG_READ"#auth#markMsgRead"
NEW_MESSAGES"#auth#hasNewMessages"
NEW_NOTIFICATIONS"#auth#hasNewNotifications"
READY"#auth#ready"
SIGN_AUTH_MESSAGE"#auth#signAuthMessage"
SIGN_AUTH_MESSAGE_SUCCESS"#auth#signAuthMessage#success"
SIGN_COMPOSED_MESSAGE"#auth#signComposedMessage"
SIGN_COMPOSED_MESSAGE_SUCCESS"#auth#signComposedMessage#success"
SIGN_IN"#auth#signIn"
SIGN_OUT"#auth#signOut"
SIGN_TOKEN_MESSAGE"#auth#signTokenMessage"
SIGN_TOKEN_MESSAGE_SUCCESS"#auth#signTokenMessage#success"
WAIT_FOR_AUTH"#auth#waitForAuth"

COMMENTS_EVENTS​

Enumeration Members​

Enumeration MemberValue
CREATE"#comments#Create"
EDIT"#comments#Edit"
REMOVE"#comments#Remove"

ENS_EVENTS​

Enumeration Members​

Enumeration MemberValue
CLAIM"#ens#Claim"
REGISTER"#ens#Register"

ENTRY_EVENTS​

Enumeration Members​

Enumeration MemberValue
CREATE"#entries#Create"
EDIT"#entries#Edit"
REMOVE"#entries#Remove"

EthProviders​

Enumeration Members​

Enumeration MemberValue
FallbackProvider4
None1
Torus5
WalletConnect3
Web3Injected2

GQL_EVENTS​

Enumeration Members​

Enumeration MemberValue
MUTATION"gql#mutation#event"

INJECTED_PROVIDERS​

Enumeration Members​

Enumeration MemberValue
CIPHER"Cipher"
COINBASE"Coinbase"
DAPPER"Dapper"
FALLBACK"Web3"
IM_TOKEN"imToken"
METAMASK"MetaMask"
NIFTY"Nifty"
NOT_DETECTED"NotDetected"
OPERA"Opera"
SAFE"Safe"
STATUS"Status"
TRUST"Trust"

Enumeration Members​

Enumeration MemberValue
APP_GUIDE"AppGuide"
CODE_OF_CONDUCT"CodeOfConduct"
PRIVACY_POLICY"PrivacyPolicy"
TERMS_OF_SERVICE"TermsOfService"
TERMS_OF_USE"TermsOfUse"

PROFILE_EVENTS​

Enumeration Members​

Enumeration MemberValue
ADD_PROVIDER"#profile#AddProvider"
DEFAULT_PROVIDER"#profile#DefaultProvider"
FOLLOW"#profile#Follow"
REGISTER_USERNAME"#profile#RegisterUsername"
TAG_SUBSCRIPTION"#profile#TagSubscription"
UNFOLLOW"#profile#UnFollow"

PROVIDER_ERROR_CODES​

Enumeration Members​

Enumeration MemberValue
RequestTimeout4003
UserRejected4001
WrongNetwork4002

PostType​

Enumeration Members​

Enumeration MemberValue
APP2
ARTICLE1
DEFAULT0

TAG_EVENTS​

Enumeration Members​

Enumeration MemberValue
CREATE"#tags#Create"

WEB3_EVENTS​

Enumeration Members​

Enumeration MemberValue
ACCOUNT_CHANGED"#web3#accountChanged"
CHAIN_CHANGED"#web3#chainChanged"
CONNECTED"#web3#connected"
DISCONNECTED"#web3#disconnected"
WC_MODAL_CLOSED"#web3#modalClosed"

Interfaces​

IDBService<DB, Collection>​

Type parameters​

Type parameter
DB
Collection

Methods​

getCollection()​

getCollection(name): ServiceCallResult<Collection>

Parameters​
ParameterType
namestring
Returns​

ServiceCallResult<Collection>

Source​

typings/lib/sdk/db.d.ts:5

getDb()​

getDb(): ServiceCallResult<DB>

Returns​

ServiceCallResult<DB>

Source​

typings/lib/sdk/db.d.ts:4

open()​

open(version): ServiceCallResult<DB>

Parameters​
ParameterType
versionnumber
Returns​

ServiceCallResult<DB>

Source​

typings/lib/sdk/db.d.ts:3

IGqlClient<T>​

Type parameters​

Type parameter
T

Methods​

getAPI()​

getAPI(withCache): T

Parameters​
ParameterType
withCacheboolean
Returns​

T

Source​

typings/lib/sdk/gql.d.ts:2

LinkPreview_Response​

Properties​

PropertyType
contentTypestring
descriptionstring
faviconPreviewHash?string
favicons[string]
imagePreviewHash?string
images[string]
mediaTypestring
siteNamestring
titlestring
urlstring
videos[VideoPreview_Response]

VideoPreview_Response​

Properties​

PropertyType
heightstring
secureUrlstring
typestring
urlstring
widthstring

Type Aliases​

AWF_APP_BUILD_MANIFEST​

AWF_APP_BUILD_MANIFEST: object

Type declaration​

MemberType
linksz.infer<typeof IntegrationInfoLinksSchema>
sourcesstring[]

Source​

typings/lib/sdk/registry.d.ts:22

CurrentUser​

CurrentUser: z.infer<typeof CurrentUserSchema>

Source​

typings/lib/sdk/common.d.ts:42

DataProviderInput​

DataProviderInput: z.infer<typeof DataProviderInputSchema>

Source​

typings/lib/sdk/common.d.ts:26

Ens​

Ens: z.infer<typeof EnsSchema>

Source​

typings/lib/sdk/common.d.ts:44

EthAddress​

EthAddress: z.infer<typeof EthAddressSchema>

Source​

typings/lib/sdk/common.d.ts:4

GlobalEventBusData<D>​

GlobalEventBusData<D>: object

Type parameters​

Type parameterValue
Dunknown

Type declaration​

MemberType
argsunknown
dataD
eventAUTH_EVENTS | APP_EVENTS | COMMENTS_EVENTS | ENS_EVENTS | ENTRY_EVENTS | PROFILE_EVENTS | TAG_EVENTS | WEB3_EVENTS | GQL_EVENTS

Source​

typings/lib/sdk/common.d.ts:27

IntegrationId​

IntegrationId: z.infer<typeof IntegrationIdSchema>

Source​

typings/lib/sdk/registry.d.ts:3

IntegrationName​

IntegrationName: z.infer<typeof IntegrationNameSchema>

Source​

typings/lib/sdk/registry.d.ts:7

IntegrationReleaseId​

IntegrationReleaseId: z.infer<typeof IntegrationReleaseIdSchema>

Source​

typings/lib/sdk/registry.d.ts:5

InviteCode​

InviteCode: z.infer<typeof InviteCodeSchema>

Source​

typings/lib/sdk/common.d.ts:12

PubKey​

PubKey: z.infer<typeof PubKeySchema>

Source​

typings/lib/sdk/common.d.ts:8

ServiceCallResult<T>​

ServiceCallResult<T>: Observable<object>

Type declaration​

MemberType
dataT

Type parameters​

Type parameter
T

Source​

typings/lib/sdk/responses.d.ts:2

TagName​

TagName: z.infer<typeof TagNameSchema>

Source​

typings/lib/sdk/common.d.ts:6

Username​

Username: z.infer<typeof UsernameSchema>

Source​

typings/lib/sdk/common.d.ts:10

Variables​

CurrentUserSchema​

const CurrentUserSchema: z.ZodObject<object, "strip", z.ZodTypeAny, object, object>

Type declaration​

MemberType
ethAddressz.ZodOptional<z.ZodString>
idz.ZodString

Source​

typings/lib/sdk/common.d.ts:32

DataProviderInputSchema​

const DataProviderInputSchema: z.ZodObject<object, "strip", z.ZodTypeAny, object, object>

Type declaration​

MemberType
propertyz.ZodString
providerz.ZodString
valuez.ZodString

Source​

typings/lib/sdk/common.d.ts:13

EnsSchema​

const EnsSchema: z.ZodEffects<z.ZodString, string, string>

Source​

typings/lib/sdk/common.d.ts:43

EthAddressSchema​

const EthAddressSchema: z.ZodString

Source​

typings/lib/sdk/common.d.ts:3

EthProvidersSchema​

const EthProvidersSchema: z.ZodNativeEnum<typeof EthProviders>

Source​

typings/lib/sdk/web3.connector.d.ts:9

IntegrationIdSchema​

const IntegrationIdSchema: z.ZodString

Source​

typings/lib/sdk/registry.d.ts:2

IntegrationInfoLinksSchema​

const IntegrationInfoLinksSchema: z.ZodObject<object, "strip", z.ZodTypeAny, object, object>

Type declaration​

MemberType
detailedDescriptionz.ZodOptional<z.ZodString>
documentationz.ZodOptional<z.ZodString>
publicRepositoryz.ZodOptional<z.ZodString>

Source​

typings/lib/sdk/registry.d.ts:9

IntegrationNameSchema​

const IntegrationNameSchema: z.ZodString

Source​

typings/lib/sdk/registry.d.ts:6

IntegrationReleaseIdSchema​

const IntegrationReleaseIdSchema: z.ZodString

Source​

typings/lib/sdk/registry.d.ts:4

IntegrationTypeSchema​

const IntegrationTypeSchema: z.ZodNumber

Source​

typings/lib/sdk/registry.d.ts:8

InviteCodeSchema​

const InviteCodeSchema: z.ZodString

Source​

typings/lib/sdk/common.d.ts:11

LegalDocsSchema​

const LegalDocsSchema: z.ZodNativeEnum<typeof LEGAL_DOCS>

Source​

typings/lib/sdk/common.d.ts:52

PubKeySchema​

const PubKeySchema: z.ZodString

Source​

typings/lib/sdk/common.d.ts:7

TYPES​

const TYPES: object

Type declaration​

MemberType
AppSettingssymbol
Authsymbol
Ceramicsymbol
Commentsymbol
Configsymbol
Dbsymbol
ENSsymbol
Entrysymbol
EventBussymbol
Gqlsymbol
ICRegistrysymbol
IPFSsymbol
Litsymbol
Logsymbol
Miscsymbol
Profilesymbol
ScrollStatesymbol
Settingssymbol
Stashsymbol
Tagsymbol
Web3symbol

Source​

typings/lib/sdk/index.d.ts:10

TagNameSchema​

const TagNameSchema: z.ZodString

Source​

typings/lib/sdk/common.d.ts:5

UsernameSchema​

const UsernameSchema: z.ZodString

Source​

typings/lib/sdk/common.d.ts:9