BMXClient Class Reference
Inherits from BMXNetworkListener :
NSObject
Declared in floo_proxy.h
Overview
@interface Client instance
Properties
chatService
@property (nonatomic, strong, readonly) BMXChatService *chatService
groupService
@property (nonatomic, strong, readonly) BMXGroupService *groupService
pushService
@property (nonatomic, strong, readonly) BMXPushService *pushService
rosterService
@property (nonatomic, strong, readonly) BMXRosterService *rosterService
rtcService
@property (nonatomic, strong, readonly) BMXRTCService *rtcService
userService
@property (nonatomic, strong, readonly) BMXUserService *userService
Class Methods
createWithConfig:
Create a BMXClient
+ (BMXClient *)createWithConfig:(BMXSDKConfig *)*config*
Parameters
config
BMXSDKConfig SDK config created
Return Value
BMXClient
Declared In
floo_proxy.h
sharedClient
+ (instancetype)sharedClient
Instance Methods
changeAppIdWithAppId:
- (BMXErrorCode)changeAppIdWithAppId:(NSString *)*appId*
changeAppIdWithAppId:appSecret:
Change appId，also works on appId in BMXConfig
- (BMXErrorCode)changeAppIdWithAppId:(NSString *)*appId* appSecret:(NSString *)*appSecret*
Parameters
appId
The new appId
Return Value
Declared In
floo_proxy.h
changeAppIdWithAppId:appSecret:completion:
Change appId，also works on appId in BMXConfig
- (void)changeAppIdWithAppId:(NSString *)*appId* appSecret:(NSString *)*appSecret* completion:(void ( ^ ) ( BMXError *aError ))*resBlock*
Parameters
appId
The new appId
Return Value
Declared In
floo_proxy.h
changeAppIdWithAppId:completion:
- (void)changeAppIdWithAppId:(NSString *)*appId* completion:(void ( ^ ) ( BMXError *aError ))*resBlock*
connectStatus
Get connection status to the server
- (BMXConnectStatus)connectStatus
Return Value
Declared In
floo_proxy.h
dealloc
- (void)dealloc
deleteAccountWithPassword:
Delete my account
- (BMXErrorCode)deleteAccountWithPassword:(NSString *)*password*
Parameters
password
The password for my account
Return Value
Declared In
floo_proxy.h
deleteAccountWithPassword:completion:
Delete my account
- (void)deleteAccountWithPassword:(NSString *)*password* completion:(void ( ^ ) ( BMXError *aError ))*resBlock*
Parameters
password
The password for my account
Return Value
Declared In
floo_proxy.h
disconnect
Disconnect from the server
- (void)disconnect
Declared In
floo_proxy.h
disconnectWithCompletion:
Disconnect from the server
- (void)disconnectWithCompletion:(void ( ^ ) ( BMXError *aError ))*resBlock*
Declared In
floo_proxy.h
fastSignInByIdWithUid:password:
Fast login by user ID (A successful login required)
- (BMXErrorCode)fastSignInByIdWithUid:(long long)*uid* password:(NSString *)*password*
Parameters
uid
The user ID
password
The password
Return Value
Declared In
floo_proxy.h
fastSignInByIdWithUid:password:completion:
Fast login by user ID (A successful login required)
- (void)fastSignInByIdWithUid:(long long)*uid* password:(NSString *)*password* completion:(void ( ^ ) ( BMXError *aError ))*resBlock*
Parameters
uid
The user ID
password
The password
Return Value
Declared In
floo_proxy.h
fastSignInByNameWithName:password:
Fast login by username (A successful login required)
- (BMXErrorCode)fastSignInByNameWithName:(NSString *)*name* password:(NSString *)*password*
Parameters
name
The username
password
The password
Return Value
Declared In
floo_proxy.h
fastSignInByNameWithName:password:completion:
Fast login by username (A successful login required)
- (void)fastSignInByNameWithName:(NSString *)*name* password:(NSString *)*password* completion:(void ( ^ ) ( BMXError *aError ))*resBlock*
Parameters
name
The username
password
The password
Return Value
Declared In
floo_proxy.h
getSDKConfig
Get SDK config
- (BMXSDKConfig *)getSDKConfig
Return Value
Declared In
floo_proxy.h
initializeServerConfigWithIsLocal:
Initialize server config to accelerate login speed
- (BMXErrorCode)initializeServerConfigWithIsLocal:(BOOL)*isLocal*
Parameters
isLocal
true for loading from local file, or downloading from server
Return Value
Declared In
floo_proxy.h
initializeServerConfigWithIsLocal:completion:
Initialize server config to accelerate login speed
- (void)initializeServerConfigWithIsLocal:(BOOL)*isLocal* completion:(void ( ^ ) ( BMXError *aError ))*resBlock*
Parameters
isLocal
true for loading from local file, or downloading from server
Return Value
Declared In
floo_proxy.h
onNetworkChangedWithType:reconnect:
Send network status change events to SDK
- (void)onNetworkChangedWithType:(BMXNetworkType)*type* reconnect:(BOOL)*reconnect*
Parameters
type
New network type
reconnect
Need to reconnect or not
Declared In
floo_proxy.h
reconnect
Enforce reconnection
- (void)reconnect
Declared In
floo_proxy.h
reconnectWithCompletion:
Enforce reconnection
- (void)reconnectWithCompletion:(void ( ^ ) ( BMXError *aError ))*resBlock*
Declared In
floo_proxy.h
sendMessageWithMsg:
Send a message
- (void)sendMessageWithMsg:(BMXMessage *)*msg*
Parameters
msg
The message
Declared In
floo_proxy.h
sendMessageWithMsg:completion:
Send a message
- (void)sendMessageWithMsg:(BMXMessage *)*msg* completion:(void ( ^ ) ( BMXError *aError ))*resBlock*
Parameters
msg
The message
Declared In
floo_proxy.h
signInByIdWithArg1:password:
Sign in by username
- (BMXErrorCode)signInByIdWithArg1:(long long)*arg1* password:(NSString *)*password*
Parameters
password
The password
name
THe username
Return Value
Declared In
floo_proxy.h
signInByIdWithArg1:password:completion:
Sign in by user ID
- (void)signInByIdWithArg1:(long long)*arg1* password:(NSString *)*password* completion:(void ( ^ ) ( BMXError *aError ))*resBlock*
Parameters
password
The password
int64_t
The user ID
Return Value
Declared In
floo_proxy.h
signInByNameWithName:password:
Sign in by username
- (BMXErrorCode)signInByNameWithName:(NSString *)*name* password:(NSString *)*password*
Parameters
name
The username
password
The password
Return Value
Declared In
floo_proxy.h
signInByNameWithName:password:completion:
Sign in by username
- (void)signInByNameWithName:(NSString *)*name* password:(NSString *)*password* completion:(void ( ^ ) ( BMXError *aError ))*resBlock*
Parameters
name
The username
password
The password
Return Value
Declared In
floo_proxy.h
signInStatus
Get login status
- (BMXSignInStatus)signInStatus
Return Value
Declared In
floo_proxy.h
signOut
- (BMXErrorCode)signOut
signOutWithCompletion:
- (void)signOutWithCompletion:(void ( ^ ) ( BMXError *aError ))*resBlock*
signOutWithUid:
- (BMXErrorCode)signOutWithUid:(long long)*uid*
signOutWithUid:completion:
- (void)signOutWithUid:(long long)*uid* completion:(void ( ^ ) ( BMXError *aError ))*resBlock*
signOutWithUid:ignoreUnbindDevice:
Sign out
- (BMXErrorCode)signOutWithUid:(long long)*uid* ignoreUnbindDevice:(BOOL)*ignoreUnbindDevice*
Parameters
uid
My user ID
ignoreUnbindDevice
Ignore unbinding device on sign out
Return Value
Declared In
floo_proxy.h
signOutWithUid:ignoreUnbindDevice:completion:
Sign out
- (void)signOutWithUid:(long long)*uid* ignoreUnbindDevice:(BOOL)*ignoreUnbindDevice* completion:(void ( ^ ) ( BMXError *aError ))*resBlock*
Parameters
uid
My user ID
ignoreUnbindDevice
Ignore unbinding device on sign out
Return Value
Declared In
floo_proxy.h
signUpNewUserWithUsername:password:bmxUserProfilePtr:
Sign up a new account
- (BMXErrorCode)signUpNewUserWithUsername:(NSString *)*username* password:(NSString *)*password* bmxUserProfilePtr:(BMXUserProfile *)*bmxUserProfilePtr*
Parameters
username
The username
password
The password
bmxUserProfilePtr
Profile of the new user
Return Value
Declared In
floo_proxy.h
signUpNewUserWithUsername:password:completion:
Sign up a new account
- (void)signUpNewUserWithUsername:(NSString *)*username* password:(NSString *)*password* completion:(void ( ^ ) ( BMXUserProfile *profile , BMXError *aError ))*resBlock*
Parameters
username
The username
password
The password
bmxUserProfilePtr
Profile of the new user
Return Value
Declared In
floo_proxy.h
Example: