SBDOptions Class Reference

Inherits from NSObject
Declared in SBDOptions.h

Overview

Represents operation options.

+ useMemberAsMessageSender

Gets the value whether the sender information of sender of SBDUserMessage or SBDFileMessage such as nickname and profile url will be returned as the latest user’s or not.

+ (BOOL)useMemberAsMessageSender

Return Value

If YES, the sender is the latest information.

Declared In

SBDOptions.h

+ setUseMemberAsMessageSender:

If set YES, the sender information of sender of SBDUserMessage or SBDFileMessage such as nickname and profile url will be returned as the latest user’s. Otherwise, the information will be the value of the message creation time.

+ (void)setUseMemberAsMessageSender:(BOOL)tf

Parameters

tf

YES or NO.

Declared In

SBDOptions.h

+ setConnectionTimeout:

Sets the timeout for connection. If there is a timeout error frequently, set the longer timeout than default value. The default is 10 seconds.

+ (void)setConnectionTimeout:(NSInteger)timeout

Parameters

timeout

The timeout for connection.

Declared In

SBDOptions.h

+ setTypingIndicatorThrottle:

Sets a term of typing indicator throttling in group channel. After this throttling interval from typing indicator started (or ended), You can re-start (or re-end) typing indicator. If you call start (or end) again in this interval, the call will be ignored.

+ (void)setTypingIndicatorThrottle:(NSTimeInterval)interval

Parameters

interval

A time interval that can renew typing indicator. can be RANGE from 1.0 to 9.0.

Availability

3.0.100

Declared In

SBDOptions.h

+ setAuthenticationTimeout:

Sets the authentication timeout managed by authenticateWithAuthInfoRequestHandler:completionHandler: of SBDConnectionManager. The default value is 10 seconds.

+ (void)setAuthenticationTimeout:(NSTimeInterval)timeout

Parameters

timeout

Timeout in seconds. It must be greater than 0. Otherwise, the default value (10 seconds) will be set.

Availability

3.0.109

Declared In

SBDOptions.h

+ setFileTransferTimeout:

Sets the timeout for file transfer. This value affects the methods that send a binary data including sending file messages, creating and updating channels.

+ (void)setFileTransferTimeout:(NSInteger)timeout

Parameters

timeout

Timeout in seconds. It must be greater than 0. Otherwise, the default value (60 seconds) will be set.

Availability

3.0.130

Declared In

SBDOptions.h

+ setWebSocketResponseTimeout:

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

+ (void)setWebSocketResponseTimeout:(NSInteger)timeout

Parameters

timeout

Timeout in seconds.

Availability

3.0.199

Declared In

SBDOptions.h