EkoChannel


@interface EkoChannel : NSObject

Channel

  • The unique identifier for the channel

    Declaration

    Objective-C

    @property (readonly, strong, nonatomic) NSString *_Nonnull channelId;

    Swift

    var channelId: String { get }

  • Channel type

    Declaration

    Objective-C

    @property (readonly, nonatomic) enum EkoChannelType channelType;

    Swift

    var channelType: EkoChannelType { get }

  • Channel metadata

    Declaration

    Objective-C

    @property (readonly, strong, nonatomic, nullable) NSDictionary<NSString *, id> *metadata;

    Swift

    var metadata: [String : Any]? { get }

  • The display name for the channel

    Declaration

    Objective-C

    @property (readonly, strong, nonatomic, nullable) NSString *displayName;

    Swift

    var displayName: String? { get }

  • isDistinct

    Declaration

    Objective-C

    @property (readonly, nonatomic) BOOL isDistinct;

    Swift

    var isDistinct: Bool { get }

  • isMuted

    Declaration

    Objective-C

    @property (readonly, nonatomic) BOOL isMuted;

    Swift

    var isMuted: Bool { get }

  • isRateLimited

    Declaration

    Objective-C

    @property (readonly, nonatomic) BOOL isRateLimited;

    Swift

    var isRateLimited: Bool { get }

  • Unread messages for the current user in the channel

    Declaration

    Objective-C

    @property (readonly, nonatomic) NSInteger unreadCount;

    Swift

    var unreadCount: Int { get }

  • Total number of users in this channel

    Declaration

    Objective-C

    @property (readonly, nonatomic) NSInteger memberCount;

    Swift

    var memberCount: Int { get }

  • Total number of messages in this channel

    Declaration

    Objective-C

    @property (readonly, nonatomic) NSInteger messageCount;

    Swift

    var messageCount: Int { get }

  • Returns a participation instance

    Declaration

    Objective-C

    @property (readonly, nonatomic) EkoChannelParticipation *_Nonnull participation;

    Swift

    var participation: EkoChannelParticipation { get }

  • The current user channel membership object

    Declaration

    Objective-C

    @property (readonly, nonatomic, nullable) EkoChannelMembership *currentMembership;

    Swift

    var currentMembership: EkoChannelMembership? { get }

  • A moderation instance

    Declaration

    Objective-C

    @property (readonly, nonatomic) EkoChannelModeration *_Nonnull moderate;

    Swift

    var moderate: EkoChannelModeration { get }

  • The channel tags

    Declaration

    Objective-C

    @property (readonly, nonatomic, nonnull) NSArray<NSString *> *tags;

    Swift

    unowned(unsafe) var tags: NSArray { get }

  • @abstract The channel last activity @discussion The last activity is updated for various reasons, for example:

    • new channel tags are set

    • a new channel name is set

    • a new message has been received

    • etc

    Declaration

    Objective-C

    @property (strong, nonatomic) NSDate *_Nonnull lastActivity;

    Swift

    var lastActivity: Date { get set }

  • @abstract Returns a channel type from create channel type enum.

    Note

    This is a helper method to helps user can convert this enum automatically to a channel type

    Declaration

    Objective-C

    + (EkoChannelType)channelTypeForCreateType:(EkoChannelCreateType)type;

    Swift

    class func channelType(for type: EkoChannelCreateType) -> EkoChannelType

    Parameters

    type

    Indicates the create channel enum type

    Return Value

    A channel type enum

  • Unavailable

    Block call of init and new because this object cannot be created directly

    Declaration

    Objective-C

    - (nonnull instancetype)init;