SBDGroupChannelParams Class Reference
| Inherits from | NSObject |
|---|---|
| Conforms to | NSCopying |
| Declared in | SBDGroupChannelParams.h |
Overview
The SBDGroupChannelParams class contain parameters for group channel. When you want to create a group channel or update a group channel, use this class. Add what you want to create with, add which properties you want to update, and pass this class to SBDGroupChannel. You can use this class with apis that are [SBDGroupChannel createChannel:completionHandler:] or [SBDGroupChannel updateChannel:completionHandler:].
For more information, see Group Channel.
channelUrl
Represents the channel is to be updated. Use in creation only.
@property (nonatomic, copy, nullable) NSString *channelUrlDeclared In
SBDGroupChannelParams.h
isSuper
Represents the channel is super channel or not. NO by default.
@property (nonatomic, setter=setSuper:) BOOL isSuperDeclared In
SBDGroupChannelParams.h
isBroadcast
Represents the channel is broadcast channel or not. NO by default.
@property (nonatomic, setter=setBroadcast:) BOOL isBroadcastAvailability
3.0.171
Declared In
SBDGroupChannelParams.h
isPublic
Represents the channel is public channel or not. NO by default, a.k.a. private.
@property (nonatomic, setter=setPublic:) BOOL isPublicDeclared In
SBDGroupChannelParams.h
isDistinct
Represents the channel is distinct or not. If YES, the channel which has the same users is returned. NO by default.
@property (nonatomic, setter=setDistinct:) BOOL isDistinctDeclared In
SBDGroupChannelParams.h
isEphemeral
Represents the channel is ephemeral or not. The default value is NO
@property (nonatomic, setter=setEphemeral:) BOOL isEphemeralAvailability
3.0.90
Declared In
SBDGroupChannelParams.h
discoverable
Represents a boolean whether the public group channel is discoverable.
It is only for creating or updating a public group channel. If the value is YES(true) and isPublic is NO(false), you will get an error from call-back of creating/updateing channel.
The default value is YES(true).
@property (nonatomic, getter=isDiscoverable) BOOL discoverableAvailability
3.0.136
Declared In
SBDGroupChannelParams.h
strict
The boolean that can cause an error if any of the users is not valid when creating the channel. If you have two valid users and ‘strictis true, the channel is created successfully when you create a channel with users. If one valid user, one invalid user, andstrictare true, you will get an error creating the channel. However, if you have one valid user, one invalid user, andstrict` is false, you can create a channel without errors without a user.
@property (nonatomic, getter=isStrict) BOOL strictAvailability
3.0.148
Declared In
SBDGroupChannelParams.h
customType
Represents the custom type of group channel.
@property (nonatomic, copy, nullable) NSString *customTypeDeclared In
SBDGroupChannelParams.h
data
Represents the custom data of group channel.
@property (nonatomic, copy, nullable) NSString *dataDeclared In
SBDGroupChannelParams.h
coverUrl
Represnets the cover image url of group channel.
@property (nonatomic, copy, nullable) NSString *coverUrlDeclared In
SBDGroupChannelParams.h
coverImage
Represents the cover image data of group channel.
@property (nonatomic, copy, nullable) NSData *coverImageDeclared In
SBDGroupChannelParams.h
name
Represents the name of group channel.
@property (nonatomic, copy, nullable) NSString *nameDeclared In
SBDGroupChannelParams.h
operatorUserIds
Represents the operators’s user id.
@property (nonatomic, copy, nullable) NSArray<NSString*> *operatorUserIdsAvailability
3.0.89
Declared In
SBDGroupChannelParams.h
accessCode
A string that allows access to the public group channel. ONLY use for public group channel.
@property (nonatomic, copy, nullable) NSString *accessCodeAvailability
3.0.116
Declared In
SBDGroupChannelParams.h
messageSurvivalSeconds
A value that sets the message survival time in seconds. In the channel that is created or updated with this option, the read messages are automatically deleted after a determined amount of time. The default value is -1 that represents the disappearing message is disabled.
@property (nonatomic, setter=setMessageSurvivalSeconds:) NSInteger messageSurvivalSecondsAvailability
3.0.172
Discussion
This feature is available in a 1-on-1 group channel.
Declared In
SBDGroupChannelParams.h
– addUser:
Add user with SBDUser class to be member of the group channel.
- (void)addUser:(nonnull SBDUser *)userParameters
user |
The user to be member of a group channel. |
|---|
Declared In
SBDGroupChannelParams.h
– addUserId:
Add user with user id to be member of the group channel.
- (void)addUserId:(nonnull NSString *)userIdParameters
userId |
The user id to be member of a group channel. |
|---|
Declared In
SBDGroupChannelParams.h
– addUsers:
Add users with SBDUser class array to be member of the group channel.
- (void)addUsers:(nonnull NSArray<SBDUser*> *)usersParameters
users |
The users to be member of a group channel. |
|---|
Declared In
SBDGroupChannelParams.h
– addUserIds:
Add users with user ids to be member of the group channel.
- (void)addUserIds:(nonnull NSArray<NSString*> *)userIdsParameters
userIds |
The user ids to be member of a group channel. |
|---|
Declared In
SBDGroupChannelParams.h
– userIds
Get users that are contained params class.
- (nullable NSArray<NSString*> *)userIdsReturn Value
userIds The user ids to be member of a group channel.
Declared In
SBDGroupChannelParams.h
– setOperators:
Set operators with list of user instance.
- (void)setOperators:(nonnull NSArray<SBDUser*> *)operatorsParameters
operators |
The list of operators. |
|---|
Availability
3.0.89
See Also
Declared In
SBDGroupChannelParams.h