Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • default

Index

Methods

  • addExtension(key: string, version: string): void
  • Parameters

    • key: string
    • version: string

    Returns void

  • addFriends(userIds: string[]): Promise<User[]>
  • Parameters

    • userIds: string[]

    Returns Promise<User[]>

  • blockUser(userOrUserId: string | User): Promise<void>
  • Parameters

    • userOrUserId: string | User

    Returns Promise<void>

  • blockUserWithUserId(userId: string): Promise<void>
  • Parameters

    • userId: string

    Returns Promise<void>

  • buildUserFromSerializedData(serialized: object): User
  • Parameters

    • serialized: object

    Returns User

  • clearCachedData(): Promise<void>
  • Returns Promise<void>

  • clearCachedMessages(channelUrls: string[]): Promise<void[]>
  • Parameters

    • channelUrls: string[]

    Returns Promise<void[]>

  • connect(userId: string, authToken?: string): Promise<User>
  • Parameters

    • userId: string
    • authToken: string = null

    Returns Promise<User>

  • deleteFriend(userId: string): Promise<void>
  • Parameters

    • userId: string

    Returns Promise<void>

  • deleteFriendDiscoveries(discoveryKeys: string[]): Promise<void>
  • Parameters

    • discoveryKeys: string[]

    Returns Promise<void>

  • deleteFriendDiscovery(discoveryKey: string): Promise<void>
  • Parameters

    • discoveryKey: string

    Returns Promise<void>

  • deleteFriends(userIds: string[]): Promise<void>
  • Parameters

    • userIds: string[]

    Returns Promise<void>

  • disconnect(): Promise<void>
  • Returns Promise<void>

  • getAllowFriendDiscovery(): Promise<boolean>
  • Returns Promise<boolean>

  • getEmoji(emojiKey: string): Promise<Emoji>
  • Parameters

    • emojiKey: string

    Returns Promise<Emoji>

  • getMemoryStoreForDebugging(): default
  • Returns default

  • initializeCache(userId: string): Promise<void>
  • Parameters

    • userId: string

    Returns Promise<void>

  • reconnect(): boolean
  • Returns boolean

  • removeAllConnectionHandler(): void
  • Returns void

  • removeAllUserEventHandler(): void
  • Returns void

  • removeConnectionHandler(key: string): void
  • Parameters

    • key: string

    Returns void

  • removeUserEventHandler(key: string): void
  • Parameters

    • key: string

    Returns void

  • setAllowFriendDiscovery(allowFriendDiscovery: boolean): Promise<boolean>
  • Parameters

    • allowFriendDiscovery: boolean

    Returns Promise<boolean>

  • setBackgroundState(): void
  • Returns void

  • setDoNotDisturb(doNotDisturbOn: boolean, startHour?: number, startMin?: number, endHour?: number, endMin?: number, timezone?: string): Promise<DoNotDisturbPreference>
  • Parameters

    • doNotDisturbOn: boolean
    • startHour: number = 0
    • startMin: number = 0
    • endHour: number = 0
    • endMin: number = 0
    • timezone: string = ''

    Returns Promise<DoNotDisturbPreference>

  • setForegroundState(): void
  • Returns void

  • setSnoozePeriod(snoozeOn: boolean, startTs?: number, endTs?: number): Promise<SnoozePeriod>
  • Parameters

    • snoozeOn: boolean
    • startTs: number = 0
    • endTs: number = 0

    Returns Promise<SnoozePeriod>

  • unblockUser(userOrUserId: string | User): Promise<void>
  • Parameters

    • userOrUserId: string | User

    Returns Promise<void>

  • unblockUserWithUserId(userId: string): Promise<void>
  • Parameters

    • userId: string

    Returns Promise<void>

  • unregisterAPNSPushTokenAllForCurrentUser(): Promise<void>
  • Returns Promise<void>

  • unregisterFCMPushTokenAllForCurrentUser(): Promise<void>
  • Returns Promise<void>

  • updateCurrentUserInfoWithPreferredLanguages(preferredLanguages: string[]): Promise<User>
  • Parameters

    • preferredLanguages: string[]

    Returns Promise<User>

Accessors

  • get version(): string
  • Returns string

  • get apnsPushToken(): string
  • Returns string

  • get appId(): string
  • Returns string

  • get appInfo(): default
  • Returns default

  • get appVersion(): string
  • Returns string

  • get currentUser(): User
  • get debugMode(): boolean
  • Returns boolean

  • get ekey(): string
  • Returns string

  • get fcmPushToken(): string
  • Returns string

  • get isCacheEnabled(): boolean
  • Returns boolean

  • get lastConnectedAt(): number
  • Returns number

Properties

message: MessageModule

Generated using TypeDoc