Class AppSettingsBuilder

Hierarchy

AppSettingsBuilder

Index

Constructors

constructor

Methods

Constructors

constructor

new AppSettingsBuilder(): AppSettingsBuilder

Returns AppSettingsBuilder

Methods

autoEstablishSocketConnection

autoEstablishSocketConnection(establishSocketConnection?: boolean): AppSettingsBuilder

Parameters
- establishSocketConnection: boolean = true
  
  A method to auto connect to WebSocket server when a user logs-in. The default value is true.
Returns AppSettingsBuilder

build

build(): AppSettings

This method will return an object of the AppSettings class.

Returns AppSettings

enableAutoJoinForGroups

enableAutoJoinForGroups(isAutoJoinEnabled?: boolean): AppSettingsBuilder

Parameters
- isAutoJoinEnabled: boolean = true
  
  A method to enable/disable auto joining group. The default value is true.
Returns AppSettingsBuilder

setRegion

setRegion(region?: string): AppSettingsBuilder

Parameters
- region: string = ...
  
  A method to set region of the app.
Returns AppSettingsBuilder

subscribePresenceForAllUsers

subscribePresenceForAllUsers(): AppSettingsBuilder

A method to subscribe presence for all users.

Returns AppSettingsBuilder

subscribePresenceForFriends

subscribePresenceForFriends(): AppSettingsBuilder

A method to subscribe presence for friends.

Returns AppSettingsBuilder

subscribePresenceForRoles

subscribePresenceForRoles(roles: string[]): AppSettingsBuilder

Parameters
- roles: string[]
  
  A method to subscribe presence for all roles.
Returns AppSettingsBuilder