Skip to main content

Namespace.typings

Enumerations​

AUTH_EVENTS​

Defined in: typings/lib/sdk/events.d.ts:1

Enumeration Members​

Enumeration MemberValueDefined in
CONNECT_ADDRESS"#auth#connectAddress"typings/lib/sdk/events.d.ts:9
CONNECT_ADDRESS_SUCCESS"#auth#connectAddress#success"typings/lib/sdk/events.d.ts:10
MARK_MSG_READ"#auth#markMsgRead"typings/lib/sdk/events.d.ts:8
NEW_MESSAGES"#auth#hasNewMessages"typings/lib/sdk/events.d.ts:5
NEW_NOTIFICATIONS"#auth#hasNewNotifications"typings/lib/sdk/events.d.ts:4
READY"#auth#ready"typings/lib/sdk/events.d.ts:3
SIGN_AUTH_MESSAGE"#auth#signAuthMessage"typings/lib/sdk/events.d.ts:11
SIGN_AUTH_MESSAGE_SUCCESS"#auth#signAuthMessage#success"typings/lib/sdk/events.d.ts:12
SIGN_COMPOSED_MESSAGE"#auth#signComposedMessage"typings/lib/sdk/events.d.ts:13
SIGN_COMPOSED_MESSAGE_SUCCESS"#auth#signComposedMessage#success"typings/lib/sdk/events.d.ts:14
SIGN_IN"#auth#signIn"typings/lib/sdk/events.d.ts:2
SIGN_OUT"#auth#signOut"typings/lib/sdk/events.d.ts:6
SIGN_TOKEN_MESSAGE"#auth#signTokenMessage"typings/lib/sdk/events.d.ts:15
SIGN_TOKEN_MESSAGE_SUCCESS"#auth#signTokenMessage#success"typings/lib/sdk/events.d.ts:16
WAIT_FOR_AUTH"#auth#waitForAuth"typings/lib/sdk/events.d.ts:7

ChannelOptionIndexes​

Defined in: typings/lib/sdk/notification.d.ts:1

Enumeration Members​

Enumeration MemberValueDefined in
ANTENNA1typings/lib/sdk/notification.d.ts:2
PROFILE2typings/lib/sdk/notification.d.ts:3
VIBES3typings/lib/sdk/notification.d.ts:4

COMMENTS_EVENTS​

Defined in: typings/lib/sdk/events.d.ts:38

Enumeration Members​

Enumeration MemberValueDefined in
CREATE"#comments#Create"typings/lib/sdk/events.d.ts:39
EDIT"#comments#Edit"typings/lib/sdk/events.d.ts:40
REMOVE"#comments#Remove"typings/lib/sdk/events.d.ts:41

ENS_EVENTS​

Defined in: typings/lib/sdk/events.d.ts:51

Enumeration Members​

Enumeration MemberValueDefined in
CLAIM"#ens#Claim"typings/lib/sdk/events.d.ts:53
REGISTER"#ens#Register"typings/lib/sdk/events.d.ts:52

ENTRY_EVENTS​

Defined in: typings/lib/sdk/events.d.ts:43

Enumeration Members​

Enumeration MemberValueDefined in
CREATE"#entries#Create"typings/lib/sdk/events.d.ts:44
EDIT"#entries#Edit"typings/lib/sdk/events.d.ts:45
REMOVE"#entries#Remove"typings/lib/sdk/events.d.ts:46

EthProviders​

Defined in: typings/lib/sdk/web3.connector.d.ts:2

Enumeration Members​

Enumeration MemberValueDefined in
FallbackProvider4typings/lib/sdk/web3.connector.d.ts:6
None1typings/lib/sdk/web3.connector.d.ts:3
Torus5typings/lib/sdk/web3.connector.d.ts:7
WalletConnect3typings/lib/sdk/web3.connector.d.ts:5
Web3Injected2typings/lib/sdk/web3.connector.d.ts:4

EXTENSION_EVENTS​

Defined in: typings/lib/sdk/events.d.ts:55

Enumeration Members​

Enumeration MemberValueDefined in
INFO_READY"#extension#ReleaseInfoReady"typings/lib/sdk/events.d.ts:56
INSTALL_STATUS"#extension#InstallStatus"typings/lib/sdk/events.d.ts:61
REMOVED"#extension#Removed"typings/lib/sdk/events.d.ts:57
TOGGLE_STATUS"#extension#ToggleStatus"typings/lib/sdk/events.d.ts:58
UPDATE_CONFIG"#extension#UpdateConfig"typings/lib/sdk/events.d.ts:60
UPDATE_VERSION"#extension#UpdateVersion"typings/lib/sdk/events.d.ts:59

GQL_EVENTS​

Defined in: typings/lib/sdk/events.d.ts:63

Enumeration Members​

Enumeration MemberValueDefined in
MUTATION"gql#mutation#event"typings/lib/sdk/events.d.ts:64

INJECTED_PROVIDERS​

Defined in: typings/lib/sdk/common.d.ts:53

Enumeration Members​

Enumeration MemberValueDefined in
CIPHER"Cipher"typings/lib/sdk/common.d.ts:61
COINBASE"Coinbase"typings/lib/sdk/common.d.ts:60
DAPPER"Dapper"typings/lib/sdk/common.d.ts:57
FALLBACK"Web3"typings/lib/sdk/common.d.ts:64
IM_TOKEN"imToken"typings/lib/sdk/common.d.ts:62
METAMASK"MetaMask"typings/lib/sdk/common.d.ts:54
NIFTY"Nifty"typings/lib/sdk/common.d.ts:56
NOT_DETECTED"NotDetected"typings/lib/sdk/common.d.ts:65
OPERA"Opera"typings/lib/sdk/common.d.ts:58
SAFE"Safe"typings/lib/sdk/common.d.ts:55
STATUS"Status"typings/lib/sdk/common.d.ts:63
TRUST"Trust"typings/lib/sdk/common.d.ts:59

Defined in: typings/lib/sdk/common.d.ts:45

Enumeration Members​

Enumeration MemberValueDefined in
APP_GUIDE"AppGuide"typings/lib/sdk/common.d.ts:50
CODE_OF_CONDUCT"CodeOfConduct"typings/lib/sdk/common.d.ts:49
PRIVACY_POLICY"PrivacyPolicy"typings/lib/sdk/common.d.ts:48
TERMS_OF_SERVICE"TermsOfService"typings/lib/sdk/common.d.ts:47
TERMS_OF_USE"TermsOfUse"typings/lib/sdk/common.d.ts:46

NOTIFICATION_EVENTS​

Defined in: typings/lib/sdk/events.d.ts:25

Enumeration Members​

Enumeration MemberValueDefined in
NEW_NOTIFICATIONS"#newNotifications"typings/lib/sdk/events.d.ts:28
SUBSCRIPTION_NOT_ACCEPTED"#notification#subscriptionNotAccepted"typings/lib/sdk/events.d.ts:26
UNREAD_NOTIFICATIONS_CLEARED"#unreadNotificationsCleared"typings/lib/sdk/events.d.ts:27

PostType​

Defined in: typings/lib/sdk/responses.d.ts:5

Enumeration Members​

Enumeration MemberValueDefined in
APP2typings/lib/sdk/responses.d.ts:8
ARTICLE1typings/lib/sdk/responses.d.ts:7
DEFAULT0typings/lib/sdk/responses.d.ts:6

PROFILE_EVENTS​

Defined in: typings/lib/sdk/events.d.ts:30

Enumeration Members​

Enumeration MemberValueDefined in
ADD_PROVIDER"#profile#AddProvider"typings/lib/sdk/events.d.ts:33
DEFAULT_PROVIDER"#profile#DefaultProvider"typings/lib/sdk/events.d.ts:34
FOLLOW"#profile#Follow"typings/lib/sdk/events.d.ts:31
REGISTER_USERNAME"#profile#RegisterUsername"typings/lib/sdk/events.d.ts:35
TAG_SUBSCRIPTION"#profile#TagSubscription"typings/lib/sdk/events.d.ts:36
UNFOLLOW"#profile#UnFollow"typings/lib/sdk/events.d.ts:32

PROVIDER_ERROR_CODES​

Defined in: typings/lib/sdk/common.d.ts:67

Enumeration Members​

Enumeration MemberValueDefined in
RequestTimeout4003typings/lib/sdk/common.d.ts:70
UserRejected4001typings/lib/sdk/common.d.ts:68
WrongNetwork4002typings/lib/sdk/common.d.ts:69

TAG_EVENTS​

Defined in: typings/lib/sdk/events.d.ts:48

Enumeration Members​

Enumeration MemberValueDefined in
CREATE"#tags#Create"typings/lib/sdk/events.d.ts:49

WEB3_EVENTS​

Defined in: typings/lib/sdk/events.d.ts:18

Enumeration Members​

Enumeration MemberValueDefined in
ACCOUNT_CHANGED"#web3#accountChanged"typings/lib/sdk/events.d.ts:21
CHAIN_CHANGED"#web3#chainChanged"typings/lib/sdk/events.d.ts:22
CONNECTED"#web3#connected"typings/lib/sdk/events.d.ts:19
DISCONNECTED"#web3#disconnected"typings/lib/sdk/events.d.ts:20
WC_MODAL_CLOSED"#web3#modalClosed"typings/lib/sdk/events.d.ts:23

Interfaces​

IDBService<DB, Collection>​

Defined in: typings/lib/sdk/db.d.ts:2

Type Parameters​

Type Parameter
DB
Collection

Methods​

getCollection()​

getCollection(name): ServiceCallResult<Collection>

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

Parameters​
ParameterType
namestring
Returns​

ServiceCallResult<Collection>

getDb()​

getDb(): ServiceCallResult<DB>

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

Returns​

ServiceCallResult<DB>

open()​

open(version): ServiceCallResult<DB>

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

Parameters​
ParameterType
versionnumber
Returns​

ServiceCallResult<DB>

IGqlClient<T>​

Defined in: typings/lib/sdk/gql.d.ts:1

Type Parameters​

Type Parameter
T

Methods​

getAPI()​

getAPI(withCache): T

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

Parameters​
ParameterType
withCacheboolean
Returns​

T

LinkPreview_Response​

Defined in: typings/lib/sdk/responses.d.ts:17

Properties​

PropertyTypeDefined in
contentTypestringtypings/lib/sdk/responses.d.ts:20
descriptionstringtypings/lib/sdk/responses.d.ts:25
faviconPreviewHash?stringtypings/lib/sdk/responses.d.ts:28
favicons[string]typings/lib/sdk/responses.d.ts:21
imagePreviewHash?stringtypings/lib/sdk/responses.d.ts:27
images[string]typings/lib/sdk/responses.d.ts:26
mediaTypestringtypings/lib/sdk/responses.d.ts:19
siteNamestringtypings/lib/sdk/responses.d.ts:24
titlestringtypings/lib/sdk/responses.d.ts:23
urlstringtypings/lib/sdk/responses.d.ts:18
videos[VideoPreview_Response]typings/lib/sdk/responses.d.ts:22

VideoPreview_Response​

Defined in: typings/lib/sdk/responses.d.ts:10

Properties​

PropertyTypeDefined in
heightstringtypings/lib/sdk/responses.d.ts:15
secureUrlstringtypings/lib/sdk/responses.d.ts:12
typestringtypings/lib/sdk/responses.d.ts:13
urlstringtypings/lib/sdk/responses.d.ts:11
widthstringtypings/lib/sdk/responses.d.ts:14

Type Aliases​

AdditionalMetadata​

AdditionalMetadata: object

Defined in: typings/lib/sdk/notification.d.ts:37

Type declaration​

NameTypeDefined in
datastringtypings/lib/sdk/notification.d.ts:38
domainstringtypings/lib/sdk/notification.d.ts:40
typestringtypings/lib/sdk/notification.d.ts:39

AWF_APP_BUILD_MANIFEST​

AWF_APP_BUILD_MANIFEST: object

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

Type declaration​

NameTypeDefined in
links?z.infer<typeof IntegrationInfoLinksSchema>typings/lib/sdk/registry.d.ts:23
sourcesstring[]typings/lib/sdk/registry.d.ts:24

ChannelOptionIndex​

ChannelOptionIndex: ANTENNA | PROFILE | VIBES

Defined in: typings/lib/sdk/notification.d.ts:81

CurrentUser​

CurrentUser: z.infer<typeof CurrentUserSchema>

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

DataProviderInput​

DataProviderInput: z.infer<typeof DataProviderInputSchema>

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

Ens​

Ens: z.infer<typeof EnsSchema>

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

EthAddress​

EthAddress: z.infer<typeof EthAddressSchema>

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

FollowNotificationMetaData​

FollowNotificationMetaData: NotificationBaseMetaData & object

Defined in: typings/lib/sdk/notification.d.ts:13

Type declaration​

NameTypeDefined in
followerstringtypings/lib/sdk/notification.d.ts:15
type"following"typings/lib/sdk/notification.d.ts:14

GlobalEventBusData<D>​

GlobalEventBusData<D>: object

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

Type Parameters​

Type ParameterDefault type
Dunknown

Type declaration​

NameTypeDefined in
args?unknowntypings/lib/sdk/common.d.ts:30
dataDtypings/lib/sdk/common.d.ts:28
eventAUTH_EVENTS | EXTENSION_EVENTS | COMMENTS_EVENTS | ENS_EVENTS | ENTRY_EVENTS | PROFILE_EVENTS | TAG_EVENTS | WEB3_EVENTS | NOTIFICATION_EVENTS | GQL_EVENTStypings/lib/sdk/common.d.ts:29

IntegrationId​

IntegrationId: z.infer<typeof IntegrationIdSchema>

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

IntegrationName​

IntegrationName: z.infer<typeof IntegrationNameSchema>

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

IntegrationReleaseId​

IntegrationReleaseId: z.infer<typeof IntegrationReleaseIdSchema>

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

InviteCode​

InviteCode: z.infer<typeof InviteCodeSchema>

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

MentionNotificationMetaData​

MentionNotificationMetaData: NotificationBaseMetaData & object

Defined in: typings/lib/sdk/notification.d.ts:23

Type declaration​

NameTypeDefined in
authorstringtypings/lib/sdk/notification.d.ts:25
beamIDstringtypings/lib/sdk/notification.d.ts:26
type"mention"typings/lib/sdk/notification.d.ts:24

NotificationBaseMetaData​

NotificationBaseMetaData: object

Defined in: typings/lib/sdk/notification.d.ts:28

Type declaration​

NameTypeDefined in
appIdstringtypings/lib/sdk/notification.d.ts:29

NotificationMetaTypes​

NotificationMetaTypes: FollowNotificationMetaData | ReflectionNotificationMetaData | MentionNotificationMetaData

Defined in: typings/lib/sdk/notification.d.ts:80

NotificationParsedMetaData​

NotificationParsedMetaData: object

Defined in: typings/lib/sdk/notification.d.ts:6

Type declaration​

NameTypeDefined in
channelIndex?numbertypings/lib/sdk/notification.d.ts:8
dataNotificationMetaTypes | stringtypings/lib/sdk/notification.d.ts:7

PubKey​

PubKey: z.infer<typeof PubKeySchema>

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

PushOrgNotification​

PushOrgNotification: object

Defined in: typings/lib/sdk/notification.d.ts:42

Type declaration​

NameTypeDefined in
epochstringtypings/lib/sdk/notification.d.ts:45
etimestringtypings/lib/sdk/notification.d.ts:75
isUnread?booleantypings/lib/sdk/notification.d.ts:78
payloadobjecttypings/lib/sdk/notification.d.ts:46
payload.dataobjecttypings/lib/sdk/notification.d.ts:47
payload.data.actastringtypings/lib/sdk/notification.d.ts:51
payload.data.additionalMeta?AdditionalMetadatatypings/lib/sdk/notification.d.ts:62
payload.data.aimgstringtypings/lib/sdk/notification.d.ts:52
payload.data.amsgstringtypings/lib/sdk/notification.d.ts:53
payload.data.appstringtypings/lib/sdk/notification.d.ts:48
payload.data.asubstringtypings/lib/sdk/notification.d.ts:54
payload.data.epochstringtypings/lib/sdk/notification.d.ts:57
payload.data.etimestringtypings/lib/sdk/notification.d.ts:58
payload.data.hiddenstringtypings/lib/sdk/notification.d.ts:59
payload.data.iconstringtypings/lib/sdk/notification.d.ts:55
payload.data.parsedMetaData?NotificationParsedMetaDatatypings/lib/sdk/notification.d.ts:63
payload.data.sectypestring | nulltypings/lib/sdk/notification.d.ts:61
payload.data.sidstringtypings/lib/sdk/notification.d.ts:49
payload.data.silentstringtypings/lib/sdk/notification.d.ts:60
payload.data.typenumbertypings/lib/sdk/notification.d.ts:56
payload.data.urlstringtypings/lib/sdk/notification.d.ts:50
payload.notificationobjecttypings/lib/sdk/notification.d.ts:68
payload.notification.bodystringtypings/lib/sdk/notification.d.ts:69
payload.notification.titlestringtypings/lib/sdk/notification.d.ts:70
payload.recipientsobjecttypings/lib/sdk/notification.d.ts:65
payload.verificationProofstringtypings/lib/sdk/notification.d.ts:72
payload_idnumbertypings/lib/sdk/notification.d.ts:43
senderstringtypings/lib/sdk/notification.d.ts:44
sidstring | nulltypings/lib/sdk/notification.d.ts:76
sourcestringtypings/lib/sdk/notification.d.ts:74
timestamp?Datetypings/lib/sdk/notification.d.ts:77

ReflectionNotificationMetaData​

ReflectionNotificationMetaData: NotificationBaseMetaData & object

Defined in: typings/lib/sdk/notification.d.ts:17

Type declaration​

NameTypeDefined in
authorstringtypings/lib/sdk/notification.d.ts:19
beamIDstringtypings/lib/sdk/notification.d.ts:20
reflectionIDstringtypings/lib/sdk/notification.d.ts:21
type"reflection"typings/lib/sdk/notification.d.ts:18

ServiceCallResult<T>​

ServiceCallResult<T>: Observable<{ data: T; }>

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

Type Parameters​

Type Parameter
T

TagName​

TagName: z.infer<typeof TagNameSchema>

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

UnknownMetaData​

UnknownMetaData: object

Defined in: typings/lib/sdk/notification.d.ts:10

Index Signature​

[key: string]: unknown

Username​

Username: z.infer<typeof UsernameSchema>

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

UserSettingType​

UserSettingType: object

Defined in: typings/lib/sdk/notification.d.ts:31

Type declaration​

NameTypeDefined in
active?booleantypings/lib/sdk/notification.d.ts:35
appNamestringtypings/lib/sdk/notification.d.ts:33
enabledbooleantypings/lib/sdk/notification.d.ts:34
indexnumbertypings/lib/sdk/notification.d.ts:32

Variables​

CurrentUserSchema​

const CurrentUserSchema: z.ZodObject<{ ethAddress: z.ZodOptional<z.ZodString>; id: z.ZodString; }, "strip", z.ZodTypeAny, { ethAddress: string; id: string; }, { ethAddress: string; id: string; }>

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

DataProviderInputSchema​

const DataProviderInputSchema: z.ZodObject<{ property: z.ZodString; provider: z.ZodString; value: z.ZodString; }, "strip", z.ZodTypeAny, { property: string; provider: string; value: string; }, { property: string; provider: string; value: string; }>

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

EnsSchema​

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

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

EthAddressSchema​

const EthAddressSchema: z.ZodString

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

EthProvidersSchema​

const EthProvidersSchema: z.ZodNativeEnum<typeof EthProviders>

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

IntegrationIdSchema​

const IntegrationIdSchema: z.ZodString

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

IntegrationInfoLinksSchema​

const IntegrationInfoLinksSchema: z.ZodObject<{ detailedDescription: z.ZodOptional<z.ZodString>; documentation: z.ZodOptional<z.ZodString>; publicRepository: z.ZodOptional<z.ZodString>; }, "strip", z.ZodTypeAny, { detailedDescription: string; documentation: string; publicRepository: string; }, { detailedDescription: string; documentation: string; publicRepository: string; }>

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

IntegrationNameSchema​

const IntegrationNameSchema: z.ZodString

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

IntegrationReleaseIdSchema​

const IntegrationReleaseIdSchema: z.ZodString

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

IntegrationTypeSchema​

const IntegrationTypeSchema: z.ZodNumber

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

InviteCodeSchema​

const InviteCodeSchema: z.ZodString

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

LegalDocsSchema​

const LegalDocsSchema: z.ZodNativeEnum<typeof LEGAL_DOCS>

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

PubKeySchema​

const PubKeySchema: z.ZodString

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

TagNameSchema​

const TagNameSchema: z.ZodString

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

TYPES​

const TYPES: object

Defined in: typings/lib/sdk/index.d.ts:11

Type declaration​

NameTypeDefined in
AppSettingssymboltypings/lib/sdk/index.d.ts:16
Authsymboltypings/lib/sdk/index.d.ts:20
Ceramicsymboltypings/lib/sdk/index.d.ts:30
Commentsymboltypings/lib/sdk/index.d.ts:24
Configsymboltypings/lib/sdk/index.d.ts:31
Dbsymboltypings/lib/sdk/index.d.ts:17
ENSsymboltypings/lib/sdk/index.d.ts:21
Entrysymboltypings/lib/sdk/index.d.ts:23
EventBussymboltypings/lib/sdk/index.d.ts:19
Gqlsymboltypings/lib/sdk/index.d.ts:12
ICRegistrysymboltypings/lib/sdk/index.d.ts:27
IPFSsymboltypings/lib/sdk/index.d.ts:26
Litsymboltypings/lib/sdk/index.d.ts:29
Logsymboltypings/lib/sdk/index.d.ts:14
Miscsymboltypings/lib/sdk/index.d.ts:28
Notificationsymboltypings/lib/sdk/index.d.ts:33
Profilesymboltypings/lib/sdk/index.d.ts:22
ScrollStatesymboltypings/lib/sdk/index.d.ts:32
Settingssymboltypings/lib/sdk/index.d.ts:15
Stashsymboltypings/lib/sdk/index.d.ts:13
Tagsymboltypings/lib/sdk/index.d.ts:25
Web3symboltypings/lib/sdk/index.d.ts:18

UsernameSchema​

const UsernameSchema: z.ZodString

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