HyphenateChatSDK  3.8.7
Instance Methods | Class Methods | Properties | List of all members
EMOptions Class Reference

#import <EMOptions.h>

Inheritance diagram for EMOptions:

Instance Methods

(BOOL isSandboxMode) - EM_DEPRECATED_IOS
 
(BOOL usingHttps) - EM_DEPRECATED_IOS
 
(NSDictionary *extension) - __deprecated_msg
 

Class Methods

(instancetype) + optionsWithAppkey:
 

Properties

NSString * appkey
 
BOOL enableConsoleLog
 
EMLogLevel logLevel
 
BOOL usingHttpsOnly
 
BOOL isAutoLogin
 
BOOL isDeleteMessagesWhenExitGroup
 
BOOL isDeleteMessagesWhenExitChatRoom
 
BOOL isChatroomOwnerLeaveAllowed
 
BOOL isAutoAcceptGroupInvitation
 
BOOL isAutoAcceptFriendInvitation
 
BOOL isAutoDownloadThumbnail
 
BOOL enableRequireReadAck
 
BOOL enableDeliveryAck
 
BOOL sortMessageByServerTime
 
BOOL isAutoTransferMessageAttachments
 
NSString * apnsCertName
 
NSString * pushKitCertName
 
BOOL enableDnsConfig
 
int chatPort
 
NSString * chatServer
 
NSString * restServer
 
NSString * dnsURL
 

Detailed Description

SDK setting options

Method Documentation

◆ __deprecated_msg

- (NSDictionary* extension) __deprecated_msg ("") 

Options extension

Provided by category EMOptions(PrivateDeploy).

◆ EM_DEPRECATED_IOS [1/2]

- (BOOL usingHttps) EM_DEPRECATED_IOS (3_0_0) 
(3_2_1)   

Whether using https, default is YES

◆ EM_DEPRECATED_IOS [2/2]

- (BOOL isSandboxMode) EM_DEPRECATED_IOS (3_0_0) 
(3_2_2)   

Whether using development environment, default is NO

Can only be set when initializing the sdk with [EMClient initializeSDKWithOptions:], can't be altered in runtime.

◆ optionsWithAppkey:

+ (instancetype) optionsWithAppkey: (NSString *)  aAppkey

Get a SDK setting options instance

Parameters
aAppkeyApp‘s unique identifier
Returns
SDK’s setting options instance

Property Documentation

◆ apnsCertName

- (NSString*) apnsCertName
readwritenonatomiccopy

Certificate name of Apple Push Notification Service

Can only be set when initializing the SDK with [EMClient initializeSDKWithOptions:], can't be altered in runtime.

◆ appkey

- (NSString*) appkey
readnonatomiccopy

Application's unique identifier

◆ chatPort

- (int) chatPort
readwritenonatomicassign

IM server port

chatPort is Only effective when isDNSEnabled is NO. Can only be set when initializing the SDK with [EMClient initializeSDKWithOptions:], cannot be altered in runtime

Provided by category EMOptions(PrivateDeploy).

◆ chatServer

- (NSString*) chatServer
readwritenonatomiccopy

IM server

chatServer is Only effective when isDNSEnabled is NO. Can only be set when initializing the SDK with [EMClient initializeSDKWithOptions:], cannot be altered in runtime

Provided by category EMOptions(PrivateDeploy).

◆ dnsURL

- (NSString*) dnsURL
readwritenonatomiccopy

DNS url

dnsURL Only effective when isDNSEnabled is YES. Can only be set when initializing the SDK with [EMClient initializeSDKWithOptions:], cannot be altered in runtime

Provided by category EMOptions(PrivateDeploy).

◆ enableConsoleLog

- (BOOL) enableConsoleLog
readwritenonatomicassign

Whether print log to console, default is NO

◆ enableDeliveryAck

- (BOOL) enableDeliveryAck
readwritenonatomicassign

Whether to send delivery acknowledgement, default is NO. If set to YES, SDK will automatically send a delivery acknowledgement when receiving a chat message

◆ enableDnsConfig

- (BOOL) enableDnsConfig
readwritenonatomicassign

Whether to allow using DNS, default is YES

Can only be set when initializing the SDK [EMClient initializeSDKWithOptions:], cannot be altered in runtime

Provided by category EMOptions(PrivateDeploy).

◆ enableRequireReadAck

- (BOOL) enableRequireReadAck
readwritenonatomicassign

whether receive message read by receiving user event

◆ isAutoAcceptFriendInvitation

- (BOOL) isAutoAcceptFriendInvitation
readwritenonatomicassign

Whether to automatically approve friend request, default is NO

◆ isAutoAcceptGroupInvitation

- (BOOL) isAutoAcceptGroupInvitation
readwritenonatomicassign

Whether to automatically accept group invitation, default is YES

◆ isAutoDownloadThumbnail

- (BOOL) isAutoDownloadThumbnail
readwritenonatomicassign

Whether to automatically download thumbnail of image&video and audio, default is YES

◆ isAutoLogin

- (BOOL) isAutoLogin
readwritenonatomicassign

Whether auto login, default is YES

The Settings are only valid before the SDK is initialized.

◆ isAutoTransferMessageAttachments

- (BOOL) isAutoTransferMessageAttachments
readwritenonatomicassign

Whether to automatically upload or download the attachment in the message, default is YES.

◆ isChatroomOwnerLeaveAllowed

- (BOOL) isChatroomOwnerLeaveAllowed
readwritenonatomicassign

if allow chat room's owner can leave the chat room, default is YES.

◆ isDeleteMessagesWhenExitChatRoom

- (BOOL) isDeleteMessagesWhenExitChatRoom
readwritenonatomicassign

Whether to delete all the chat room messages when leaving the chat room, default is YES

◆ isDeleteMessagesWhenExitGroup

- (BOOL) isDeleteMessagesWhenExitGroup
readwritenonatomicassign

Whether to delete all the group messages when leaving the group, default is YES

◆ logLevel

- (EMLogLevel) logLevel
readwritenonatomicassign

Log output level, default is EMLogLevelDebug

◆ pushKitCertName

- (NSString*) pushKitCertName
readwritenonatomiccopy

Certificate name of Apple PushKit Service

Can only be set when initializing the SDK with [EMClient initializeSDKWithOptions:], can't be altered in runtime.

◆ restServer

- (NSString*) restServer
readwritenonatomiccopy

REST server

restServer Only effective when isDNSEnabled is NO. Can only be set when initializing the SDK with [EMClient initializeSDKWithOptions:], cannot be altered in runtime

Provided by category EMOptions(PrivateDeploy).

◆ sortMessageByServerTime

- (BOOL) sortMessageByServerTime
readwritenonatomicassign

Whether to sort messages by server received time when loading message from database, default is YES.

◆ usingHttpsOnly

- (BOOL) usingHttpsOnly
readwritenonatomicassign

Whether using https only, default is NO


The documentation for this class was generated from the following file: