Class SendbirdChatOptions

constructor

• new SendbirdChatOptions(__namedParameters?): SendbirdChatOptions

• Parameters

  • __namedParameters: {
        sessionTokenRefreshTimeout: undefined | number;
        typingIndicatorInvalidateTime: undefined | number;
        typingIndicatorThrottle: undefined | number;
        useMemberInfoInMessage: undefined | boolean;
        websocketPayloadDecompression: undefined | boolean;
        websocketResponseTimeout: undefined | number;
    } = {}

    • sessionTokenRefreshTimeout: undefined | number

    • typingIndicatorInvalidateTime: undefined | number

    • typingIndicatorThrottle: undefined | number

    • useMemberInfoInMessage: undefined | boolean

    • websocketPayloadDecompression: undefined | boolean

    • websocketResponseTimeout: undefined | number

  Returns SendbirdChatOptions

websocketPayloadDecompression

sessionTokenRefreshTimeout

• get sessionTokenRefreshTimeout(): number

• Returns number

  Description

  Sets the timeout used in refreshing the sesson token when SessionHandler.onSessionTokenRequired is called. The value should be between 60,000ms and 1,800,000ms (30 minutes). The default value is 60,000ms.

• set sessionTokenRefreshTimeout(value): void

• Parameters

  • value: number

  Returns void

typingIndicatorInvalidateTime

• get typingIndicatorInvalidateTime(): number

• Returns number

  Description

  Sets timer to invalidate typing indicator in ms. The default value is 10,000ms.

• set typingIndicatorInvalidateTime(value): void

• Parameters

  • value: number

  Returns void

typingIndicatorThrottle

• get typingIndicatorThrottle(): number

• Returns number

  Description

  Sets typing indicator throttle in ms. Refer to GroupChannel.startTyping, GroupChannel.endTyping The default value is 1000ms.

• set typingIndicatorThrottle(value): void

• Parameters

  • value: number

  Returns void

useMemberInfoInMessage

• get useMemberInfoInMessage(): boolean

• Returns boolean

  Description

  If set to true, the member information of a channel would update user information.

• set useMemberInfoInMessage(value): void

• Parameters

  • value: boolean

  Returns void

websocketResponseTimeout

• get websocketResponseTimeout(): number

• Returns number

  Description

  Sets the websocket response timeout used in sending/receiving commmands by websocket. The value should be between 5000ms and 300,000ms (5 minutes). The default value is 10,000ms.

• set websocketResponseTimeout(value): void

• Parameters

  • value: number

  Returns void