UnreadItemCount
public final class UnreadItemCount: NSObject, Codable
extension UnreadItemCount: Mappable
The UnreadItemCount
class represents counts of messages. The instance of this class is returned
from completion handler in getUnreadItemCountWithKey:completionHandler:]
.
-
The count of unread message in all of group channels.
When you requested with
UnreadItemKey.groupChannelUnreadMessageCount
, then you can get unsigned integer count. If you DID NOT REQUESTUnreadItemKey.groupChannelUnreadMessageCount
, this property will beNSNotFound
.Since
3.0.103Declaration
Swift
public internal(set) var groupChannelUnreadMessageCount: UInt
-
The count of unread message in all of non super group channel.
When you requested with
UnreadItemKey.nonSuperUnreadMessageCount
, then you can get unsigned integer count. If you DID NOT REQUESTUnreadItemKey.nonSuperUnreadMessageCount
, this property will beNSNotFound
.Since
3.0.101Declaration
Swift
public internal(set) var nonSuperUnreadMessageCount: UInt
-
The count of unread message in all of non super group channel.
When you requested with
UnreadItemKey.superUnreadMessageCount
, then you can get unsigned integer count. If you DID NOT REQUESTUnreadItemKey.superUnreadMessageCount
, this property will beNSNotFound
.Since
3.0.101Declaration
Swift
public internal(set) var superUnreadMessageCount: UInt
-
The count of unread mention in all of group channels.
When you requested with
UnreadItemKey.groupChannelUnreadMentionCount
, then you can get unsigned integer count. If you DID NOT REQUESTUnreadItemKey.groupChannelUnreadMentionCount
, this property will beNSNotFound
.Since
3.0.103Declaration
Swift
public internal(set) var groupChannelUnreadMentionCount: UInt
-
The count of unread mention in all of non super group channel.
When you requested with
UnreadItemKey.nonSuperUnreadMentionCount
, then you can get unsigned integer count. If you DID NOT REQUESTUnreadItemKey.nonSuperUnreadMentionCount
, this property will beNSNotFound
.Since
3.0.103Declaration
Swift
public internal(set) var nonSuperUnreadMentionCount: UInt
-
The count of unread mention in all of non super group channel.
When you requested with
UnreadItemKey.superUnreadMentionCount
, then you can get unsigned integer count. If you DID NOT REQUESTUnreadItemKey.superUnreadMentionCount
, this property will beNSNotFound
.Since
3.0.103Declaration
Swift
public internal(set) var superUnreadMentionCount: UInt
-
The count of unread message in all of group channels.
When you requested with
UnreadItemKey.superInvitationCount
, then you can get unsigned integer count. If you DID NOT REQUESTUnreadItemKey.superInvitationCount
, this property will beNSNotFound
.Since
3.0.103Declaration
Swift
public internal(set) var groupChannelInvitationCount: UInt
-
The count of unread message in all of non super group channel.
When you requested with
UnreadItemKey.nonSuperInvitationCount
, then you can get unsigned integer count. If you DID NOT REQUESTUnreadItemKey.nonSuperInvitationCount
, this property will beNSNotFound
.Since
3.0.101Declaration
Swift
public internal(set) var nonSuperInvitationCount: UInt
-
The count of unread message in all of non super group channel.
When you requested with
UnreadItemKey.superInvitationCount
, then you can get unsigned integer count. If you DID NOT REQUESTUnreadItemKey.superInvitationCount
, this property will beNSNotFound
.Since
3.0.101Declaration
Swift
public internal(set) var superInvitationCount: UInt
-
Returns a Boolean value that indicates whether a count of a given key is present, not NSNotFound.
Since
3.0.101Declaration
Swift
public func has(_ key: UnreadItemKey) -> Bool
Parameters
key
An key to look for a count in the instance.
Return Value
true
if counts for key is present in the instance, otherwisefalse
. -
Returns count for a given key.
Since
3.0.101Declaration
Swift
public func unsignedIntegerForKey(_ key: UnreadItemKey) -> UInt
Parameters
key
An key to get a count in the instance.
Return Value
Unsinged integer of the count for a given key. If key is composed of multiple UnreadItemKey, the return value is combined.
-
Default constructor
Declaration
Swift
public override init()
-
Default constructor.
Declaration
Swift
public required init(from decoder: Decoder) throws
Parameters
decoder
Decoder
instance -
Initialize with json dictionary
Declaration
Swift
public func initWithDictionary(_ json: [String: Any]) -> Self?
-
Converts the object into dictionary
Declaration
Swift
public func _toDictionary() -> [String: Any]