On this page

Manage channel updates

Update channel details and receive events whenever someone updates them.

Requires App Context

To store data about channels, you must enable App Context for your app's keyset in the Admin Portal.

Update channel details​

You can edit the metadata of an existing channel with update() and updateChannel().

Both of them give the same output. The only difference is that you call a given method either on the Chat (updateChannel()) or the Channel (update()) object. Depending on the object, these methods take a different set of input parameters - you either have to specify the channel ID you want to update or not because it's already known.

Method signature​

These methods take the following parameters:

  • update()

    1channel.update(
    2    name: String?,
    3    custom: CustomObject?,
    4    description: String?,
    5    status: String?,
    6    type: ChannelType?,
    7): PNFuture<Channel>

  • updateChannel()

    1chat.updateChannel(
    2    id: String,
    3    name: String?,
    4    custom: CustomObject?,
    5    description: String?,
    6    status: String?,
    7    type: ChannelType?,
    8): PNFuture<Channel>

Input​

ParameterRequired in update()Required in updateChannel()Description
id
Type: String
Default:
n/a
No
Yes
Unique channel identifier.
name
Type: String
Default:
n/a
No
No
Display name for the channel.
custom
Type: CustomObject
Default:
n/a
No
No
JSON object providing custom data about the channel. Values must be scalar only; arrays or objects are not supported. App Context filtering language doesn’t support filtering by custom properties.
description
Type: String
Default:
n/a
No
No
Additional details about the channel.
status
Type: String
Default:
n/a
No
No
Tag that categorizes a channel by its state, like archived.
type
Type: String
Default:
n/a
No
No
Tag that categorizes a channel by its function, like offtopic.
API limits

To learn about the maximum length of parameters used to set channel metadata, refer to REST API docs.

Output​

TypeDescription
PNFuture<Channel>
PNFuture containing the updated channel object with its metadata.

Sample code​

Update the description of the support channel.

  • update()

    1// reference the "channel" object
    2chat.getChannel("support").async {
    3    it.onSuccess { channel ->
    4        // invoke the "update()" method on the "channel" object
    5        channel.update(description = "Channel for CRM tickets").async {
    6            ... // handle success and failure
    7        }
    8    }.onFailure { ... /* handle failure */ }
    9}

  • updateChannel()

    1// reference the "chat" object and invoke the "updateChannel()" method
    2chat.updateChannel(
    3    "support",
    4    description = "Channel for CRM tickets"
    5).async {
    6    ... // handle success and failure
    7}

Get channel updates​

You can receive updates when specific Channel object(s) are edited or removed on other clients using the following methods:

  • streamUpdates() checks updates on a single Channel object and it's tied to an instance of the Channel class.
  • streamUpdatesOn() checks updates on a Channel object list and it's tied to the Channel class.

Both methods accept a callback function as an argument. The Chat SDK invokes this callback whenever someone adds, changes, or removes channel metadata.

Underneath, these methods subscribe the current user to a channel and add an objects event listener to receive all objects events of type channel. These methods also return the unsubscribe function you can invoke to stop receiving objects events and unsubscribe from the channel.

Method signature​

These methods take the following parameters:

  • streamUpdates()

    1channel.streamUpdates(callback: (channel: Channel?) -> Unit): AutoCloseable

  • streamUpdatesOn()

    1class Channel {
    2    companion object {
    3        fun streamUpdatesOn(
    4            channels: Collection<Channel>,
    5            callback: (channels: Collection<Channel>) -> Unit
    6        ): AutoCloseable
    7    }
    8}

Input​

ParameterRequired in streamUpdates()Required in streamUpdatesOn()Description
channels
Type: Collection<Channel>
Default:
n/a
No
Yes
A collection of Channel objects for which you want to get updates.
callback
Type: (channel: Channel?) -> Unit
Default:
n/a
Yes
No
Function that takes a single Channel object. It defines the custom behavior to be executed when detecting channel changes.
callback
Type: (channels: Collection<Channel>) -> Unit
Default:
n/a
No
Yes
Function that takes a set of Channel objects. It defines the custom behavior to be executed when detecting channel changes.

Output​

TypeDescription
AutoCloseable
Interface that lets you stop receiving channel-related updates (objects events) by invoking the close() method.

Sample code​

  • streamUpdates()

    Get updates on the support channel.

    1val supportChannel: Channel
    2 
    3... 
    4

    5val subscription = supportChannel.streamUpdates { updatedChannel ->
    6    println("-=Updated channel: $updatedChannel")
    7}
    8

    9...
    10// always remember to call close to stop receiving updates:
    11subscription.close()

  • streamUpdatesOn()

    Get updates on the support and incident-management channels.

    1val supportChannel: Channel
    2val incidentManagementChannel: Channel
    3       
    4...
    5

    6// create a list of channels to monitor
    7val channelsToMonitor = listOf(supportChannel, incidentManagementChannel)
    8        
    9// monitor updates on the specified channels
    10Channel.streamUpdatesOn(channels = channelsToMonitor) { updatedChannels ->
    11    println("-=Updated channels: $updatedChannels")
    12}
    13

    14...
    15// always remember to call close to stop receiving updates:
    show all 16 lines
Last updated on
On this page