VIUser
Interface that represents user information. Voximplant users are created via the Voximplant control panel or HTTP API.
Props
conversationList
@property (strong, nullable, readonly, nonatomic) NSArray<NSString *> *
conversationList
Array of UUIDs of the conversations that the user currently belongs to.
Can be empty array if user does not belong to any conversation or nil if this property is accessed not for the current user.
Returns
type:
NSArray<NSString *> *
customData
@property (strong, readonly, nonatomic) NSDictionary<NSString *, NSObject *> *
customData
Specified user's public custom data available to all users.
A custom data can be set via the [VIMessenger editUserWithCustomData:privateCustomData:completion:] method.
Returns
type:
NSDictionary<NSString *, NSObject *> *
deleted
@property (assign, readonly, nonatomic, getter = isDeleted) BOOL
deleted
Whether the user is deleted.
Returns
type:
BOOL
displayName
@property (strong, readonly, nonatomic) NSString *
displayName
User's display name which is specified during user creation via the Voximplant control panel or HTTP API.
The display name is available to all users.
Returns
type:
NSString *
imId
@property (strong, readonly, nonatomic) NSNumber *
imId
IM unique ID that is used to identify users in events and specify in user-related methods.
Returns
type:
NSNumber *
leaveConversationList
@property (strong, nullable, readonly, nonatomic) NSArray<NSString *> *
leaveConversationList
Array of UUIDs for the conversations that:
- the user belonged to, but currently is not participating in
- are not removed
Can be an empty array if a user has not left any conversation or nil if this property is accessed not for the current user.
Returns
type:
NSArray<NSString *> *
name
@property (strong, readonly, nonatomic) NSString *
name
Voximplant user identifier, for example 'username@appname.accname'.
Returns
type:
NSString *
notifications
@property (strong, nullable, readonly, nonatomic) NSArray<VIMessengerNotification> *
notifications
Array of messenger notifications that the current user is subscribed to.
Note that if the property is accessed not for the current user, the result is nil.
Returns
type:
NSArray<VIMessengerNotification> *
privateCustomData
@property (strong, nullable, readonly, nonatomic) NSDictionary<NSString *, NSObject *> *
privateCustomData
Private custom data available only to the current user.
Value of this property is nil if this property is accessed not for the current user.
Returns
type:
NSDictionary<NSString *, NSObject *> *