zdk.objc
ZDKAccount.h
1//
2// ZDKAccount.h
3// ZDK
4//
5
6#ifndef ZDKAccount_h
7#define ZDKAccount_h
8
9#import <Foundation/Foundation.h>
10#import "ZDKAccountConfig.h"
11#import "ZDKAccountStatus.h"
12#import "ZDKAudioVideoCodecs.h"
13#import "ZDKAccountEventsHandler.h"
14#import "ZDKMessageType.h"
15#import "ZDKContactStateType.h"
16#import "ZDKCall.h"
17#import "ZDKSIPProbeEventsHandler.h"
18#import "ZDKSecureUserConfigType.h"
19#import "ZDKResult.h"
20#import "ZDKMessage.h"
21#import "ZDKZHandle.h"
22#import "ZDKAccountConfig.h"
23@protocol ZDKAccountConfig;
24#import "ZDKAccountEventsHandler.h"
26#import "ZDKCall.h"
27@protocol ZDKCall;
28#import "ZDKSIPProbeEventsHandler.h"
30#import "ZDKResult.h"
31@protocol ZDKResult;
32#import "ZDKMessage.h"
33@protocol ZDKMessage;
34
35NS_ASSUME_NONNULL_BEGIN
36
40
47@property(nonatomic, readonly) long int userHandle;
48
57@property(nonatomic) id<ZDKAccountConfig> configuration;
58
63@property(nonatomic, readonly) long int accountID;
64
69@property(nonatomic) NSString* _Nullable accountName;
70
77@property(nonatomic, readonly) ZDKAccountStatus registrationStatus;
78
88@property(nonatomic) NSArray<NSNumber*>* mediaCodecs;
89
90@property(nonatomic, readonly) int actualRegistrationExpiry;
91
142-(void)clearMediaCodecs;
151-(void)setStatusEventListener:(id<ZDKAccountEventsHandler>)value ;
160-(void)dropStatusEventListener:(id<ZDKAccountEventsHandler>)value ;
175-(id<ZDKCall> _Nullable)createCall:(NSString*)calleeNumber handlingVoipPhoneCallEvents:(BOOL)handlingVoipPhoneCallEvents video:(BOOL)video ;
182-(NSArray*)getActiveCalls;
193-(id<ZDKMessage>)createMessage:(ZDKMessageType)type ;
204-(id<ZDKResult>)chatSessionEnd:(NSString*)pPeer ;
217-(id<ZDKResult>)setPresenceStatus:(ZDKContactStateType)status message:(NSString* _Nullable)message ;
218-(id<ZDKResult>)stopPushAndUnregister:(BOOL)shouldRegister ;
219-(id<ZDKResult>)relinquishCallownership:(id<ZDKCall>)call ;
244-(NSString*)generateUUID:(BOOL)noPrefix bufLen:(int)bufLen ;
276-(void)setProbeEventListener:(id<ZDKSIPProbeEventsHandler>)value ;
285-(void)dropProbeEventListener:(id<ZDKSIPProbeEventsHandler>)value ;
325-(id<ZDKResult>)probeSipTransport:(NSString*)domain outboundProxy:(NSString*)outboundProxy username:(NSString*)username authUsername:(NSString*)authUsername password:(NSString*)password ;
374-(id<ZDKResult>)setTlsConfig:(ZDKSecureUserConfigType)userConf fileName:(NSString*)fileName passPhrase:(NSString* _Nullable)passPhrase ;
375-(NSString*)handlesDescription;
376
377@end
378
379NS_ASSUME_NONNULL_END
380
381#endif
The main account class.
Definition: ZDKAccount.h:39
id< ZDKResult > createUser()
Creates a new user account.
void clearMediaCodecs()
Clears the account's codec list.
NSArray * getActiveCalls()
Gets a list with all account's active/ongoing calls.
id< ZDKResult > terminateConnection()
Terminates user's TCP-based connection.
long int accountID
Gets the ID of the account.
Definition: ZDKAccount.h:63
id< ZDKResult > removeUser()
Destroys an user account object.
long int userHandle
Gets the underlying user handler ID.
Definition: ZDKAccount.h:47
NSString *_Nullable accountName
Configures the account name.
Definition: ZDKAccount.h:69
id< ZDKAccountConfig > configuration
Sets the account configuration.
Definition: ZDKAccount.h:57
ZDKAccountStatus registrationStatus
Gets the current account registration status.
Definition: ZDKAccount.h:77
id< ZDKResult > replaceUserRegistration()
Replace user registration.
NSArray< NSNumber * > * mediaCodecs
Configures the account's codecs allowed to be used.
Definition: ZDKAccount.h:88
id< ZDKResult > registerAccount()
Registers the user to the configured service.
id< ZDKResult > unRegister()
Cancels registration and/or unregisters the user.
General account configuration.
Definition: ZDKAccountConfig.h:28
Definition: ZDKAccountEventsHandler.h:27
Definition: ZDKCall.h:44
Definition: ZDKMessage.h:21
API invocation status result.
Definition: ZDKResult.h:19
Definition: ZDKSIPProbeEventsHandler.h:22
Definition: ZDKZHandle.h:13