Channels

This module is used to manage channels.

Functions

acceptChannelInvitation

abstract fun acceptChannelInvitation(channelId: String?, listener: IChannelProxy.IChannelAcceptInvitationListener?)

Accept a channel invitation.

addUsersToChannel

abstract fun addUsersToChannel(channel: Channel, type: ChannelUser.ChannelUserType, contacts: ArrayList<IRainbowContact>, listener: IChannelProxy.IChannelUpdateUsersListener?)

Adds users to a @object:Channel as type.

abstract fun addUsersToChannel(channel: Channel, type: ChannelUser.ChannelUserType, contactsId: Array<String>, listener: IChannelProxy.IChannelUpdateUsersListener?)

Adds users to a @object:Channel as type.

createChannel

abstract fun createChannel(name: String, description: String?, mode: Channel.ChannelMode?, category: String?, autoProvisioning: Boolean, maxItems: Int, listener: IChannelProxy.IChannelCreateListener?)

Create a closed company channel.

createClosedChannel

abstract fun createClosedChannel(name: String, description: String?, category: String?, autoProvisioning: Boolean, maxItems: Int, listener: IChannelProxy.IChannelCreateListener?)

Create a closed company channel.

createItem

abstract fun createItem(channel: Channel?, channelItem: IChannelItem?, listener: IChannelProxy.IChannelCreateItemListener?)

Adds an @object:ChannelItem to a @object:Channel.

createPublicChannel

abstract fun createPublicChannel(name: String, description: String?, category: String?, maxItems: Int, listener: IChannelProxy.IChannelCreateListener?)

Create a public company channel.

declineChannelInvitation

abstract fun declineChannelInvitation(channelId: String?, listener: IChannelProxy.IChannelDeclineInvitationListener?)

Decline a channel invitation.

deleteAllUsersFromChannel

abstract fun deleteAllUsersFromChannel(channel: Channel, listener: IChannelProxy.IChannelUpdateUsersListener?)

Removes all users from a @object:Channel.

deleteChannel

abstract fun deleteChannel(channel: Channel?, listener: IChannelProxy.IChannelDeleteListener?)

Delete a channel.

deleteItem

abstract fun deleteItem(channelId: String?, itemId: String?, listener: IChannelProxy.IChannelDeleteItemListener?)

Deletes an @object:ChannelItem from a @object:Channel.

deleteUsersFromChannel

abstract fun deleteUsersFromChannel(channel: Channel, contacts: ArrayList<IRainbowContact>, listener: IChannelProxy.IChannelUpdateUsersListener?)

Removes users from a @object:Channel.

abstract fun deleteUsersFromChannel(channel: Channel, contactsId: Array<String>, listener: IChannelProxy.IChannelUpdateUsersListener?)

Removes users from a @object:Channel.

fetchChannelsByCategory

abstract fun fetchChannelsByCategory(category: String?, limit: Int, listener: IChannelProxy.IChannelFetchListener?)

Fetch channels by its category (from server).

abstract fun fetchChannelsByCategory(category: String?, excludedCategories: ArrayList<String>?, limit: Int, offset: Int, listener: IChannelProxy.IChannelFetchListener?)

Fetch channels by its category (from server).

fetchChannelsByDescription

abstract fun fetchChannelsByDescription(description: String?, listener: IChannelProxy.IChannelFetchListener?)

Fetch channels by its description (from server).

fetchChannelsByName

abstract fun fetchChannelsByName(name: String?, listener: IChannelProxy.IChannelFetchListener?)

Fetch channels by its name (from server).

fetchFilteredUsers

abstract fun fetchFilteredUsers(channel: Channel, filter: ChannelMgr.ChannelUserFilter, offset: Int, limit: Int, listener: IChannelProxy.IChannelFetchUsersListener?)

Fetch users of a channel with specified limit and filtered by ALL, PUBLISHER or INVITED (from server).

fetchItems

abstract fun fetchItems(channel: Channel, itemsCount: Int, listener: IChannelProxy.IChannelFetchItemsListener?)

Fetch items from a specific channel (from server).

fetchLatestItems

abstract fun fetchLatestItems(itemsCount: Int, listener: IChannelProxy.IChannelFetchLatestItemsListener?)

Fetch latest items from all subscribed channels (from server).

fetchMostFollowedChannels

abstract fun fetchMostFollowedChannels(limit: Int, listener: IChannelProxy.IChannelFetchListener?)

Fetch most followed channels (from server).

abstract fun fetchMostFollowedChannels(limit: Int, offset: Int, listener: IChannelProxy.IChannelFetchListener?)

Fetch most followed channels (from server).

fetchMostRecentChannels

abstract fun fetchMostRecentChannels(limit: Int, listener: IChannelProxy.IChannelFetchListener?)

Fetch most recent channels (from server).

abstract fun fetchMostRecentChannels(limit: Int, offset: Int, listener: IChannelProxy.IChannelFetchListener?)

Fetch most recent channels (from server).

fetchNextItems

abstract fun fetchNextItems(channel: Channel, itemsCount: Int, date: Date?, listener: IChannelProxy.IChannelFetchItemsListener?)

Fetch items from a specific channel (from server).

fetchNextLatestItems

abstract fun fetchNextLatestItems(itemsCount: Int, date: Date?, listener: IChannelProxy.IChannelFetchLatestItemsListener?)

Fetch the next latest items from all subscribed channels (from server).

fetchReactionsForChannelItem

abstract fun fetchReactionsForChannelItem(channelId: String?, channelItemId: String?, reactionType: ChannelItem.ReactionType?, nb: Int, offset: Int, listener: IChannelProxy.IFetchReactionsListener?)

Fetch reactions from a given channel item with specified limit and offset.

fetchUsers

abstract fun fetchUsers(channel: Channel, listener: IChannelProxy.IChannelFetchUsersListener?)

Fetch the next 100 users of a channel (from server).

abstract fun fetchUsers(channel: Channel, limit: Int, listener: IChannelProxy.IChannelFetchUsersListener?)

Fetch users of a channel with specified limit (from server).

abstract fun fetchUsers(channel: Channel?, offset: Int, limit: Int, listener: IChannelProxy.IChannelFetchUsersListener?)

Fetch users of a channel with specified limit (from server).

fetchUsersByName

abstract fun fetchUsersByName(channel: Channel, nameToSearch: String, listener: IChannelProxy.IChannelFetchUsersListener?)

Fetch users matching given names (from server).

getChannelById

abstract fun getChannelById(channelId: String): Channel?

Get a @object:Channel from its id (locally).

getChannelByName

abstract fun getChannelByName(channelName: String): Channel?

Get a @object:Channel by its name but only in the user channels (locally).

markAllItemsAsRead

abstract fun markAllItemsAsRead(channel: Channel)

Mark all message items of the channel as read.

muteChannel

abstract fun muteChannel(channel: Channel?, listener: IChannelProxy.IChannelMuteListener?)

Mute a @object:Channel (no PUSH notification will be received).

registerChangeListener

abstract fun registerChangeListener(changeListener: IItemListChangeListener?)

removeUserReactionForChannelItem

abstract fun removeUserReactionForChannelItem(channelId: String?, itemId: String?, listener: IChannelProxy.IUpdateUserReactionListener?)

Removes the user reaction of a channel item

subscribeToChannel

abstract fun subscribeToChannel(channel: Channel, listener: IChannelProxy.IChannelSubscribeListener?)

Subscribe to a channel.

unMuteChannel

abstract fun unMuteChannel(channel: Channel?, listener: IChannelProxy.IChannelUnMuteListener?)

UnMute a @object:Channel (PUSH notification will be received).

unregisterChangeListener

abstract fun unregisterChangeListener(changeListener: IItemListChangeListener?)

Unregister a listener for being notified about channels changes.

unsubscribeToChannel

abstract fun unsubscribeToChannel(channel: Channel, listener: IChannelProxy.IChannelUnsubscribeListener?)

Unsubscribe from a subscribed channel.

updateChannelDescription

abstract fun updateChannelDescription(channel: Channel?, description: String?, listener: IChannelProxy.IChannelUpdateListener?)

Update the description of a channel.

updateItem

abstract fun updateItem(channel: Channel, itemId: String?, channelItem: IChannelItem, listener: IChannelProxy.IChannelCreateItemListener?)

Updates an @object:ChannelItem in a @object:Channel.

updateUserReactionForChannelItem

abstract fun updateUserReactionForChannelItem(channelId: String?, itemId: String?, reactionType: ChannelItem.ReactionType?, listener: IChannelProxy.IUpdateUserReactionListener?)

Updates the user reaction of a channel item

updateUsersToChannel

abstract fun updateUsersToChannel(channel: Channel, type: ChannelUser.ChannelUserType, contacts: ArrayList<IRainbowContact>, listener: IChannelProxy.IChannelUpdateUsersListener?)

Updates users to a @object:Channel as type.

abstract fun updateUsersToChannel(channel: Channel, type: ChannelUser.ChannelUserType, contactsId: Array<String>, listener: IChannelProxy.IChannelUpdateUsersListener?)

Updates users to a @object:Channel as type.

uploadChannelAvatar

abstract fun uploadChannelAvatar(channelId: String?, feedAvatar: File?, listener: IAvatarProxy.IAvatarListener?)

Upload channel avatar.

Properties

allChannels

abstract val allChannels: ArrayItemList<Channel>

Get all channels (user and others).

allOwnedChannels

abstract val allOwnedChannels: List<Channel>

Get all user's owned channels (locally).

allPendingChannels

abstract val allPendingChannels: List<Channel>

Get all pending channels (locally).

allSubscribedChannels

abstract val allSubscribedChannels: List<Channel>

Get all user's subscribed channels (locally).

allUserChannels

abstract val allUserChannels: List<Channel>

Get all user's channels (locally).

tenMostFollowedChannels

abstract val tenMostFollowedChannels: List<Channel>

Get ten most followed channels (locally).

tenMostRecentChannels

abstract val tenMostRecentChannels: List<Channel>

Get ten most recent channels (locally).