Class AppSettings

Hierarchy

AppSettings

Index

Properties

Methods

Properties

Static SUBSCRIPTION_TYPE_ALL_USERS

SUBSCRIPTION_TYPE_ALL_USERS: string = "ALL_USERS"

Static SUBSCRIPTION_TYPE_FRIENDS

SUBSCRIPTION_TYPE_FRIENDS: string = "FRIENDS"

Static SUBSCRIPTION_TYPE_NONE

SUBSCRIPTION_TYPE_NONE: string = "NONE"

Static SUBSCRIPTION_TYPE_ROLES

SUBSCRIPTION_TYPE_ROLES: string = "ROLES"

Methods

getIsAutoJoinEnabled

getIsAutoJoinEnabled(): boolean

This method returns whether auto joining of group was enabled or not using the enableAutoJoinForGroups() of the AppSettingsBuilder.

Returns boolean

getRegion

getRegion(): string

This method returns the region set using the setRegion() of the AppSettingsBuilder.

Returns string

getRoles

getRoles(): string[]

This method returns the roles set using the setRoles() of the AppSettingsBuilder.

Returns string[]

getSubscriptionType

getSubscriptionType(): string

This method returns the subscription type set using one of the following methods of the AppSettingsBuilder subscribePresenceForAllUsers(), subscribePresenceForRoles() or subscribePresenceForFriends().

Returns string

shouldAutoEstablishSocketConnection

shouldAutoEstablishSocketConnection(): boolean

This method returns whether the SDK should connect to WebSocket server when a user logs-in or not.

Returns boolean