Manage channel updates

Update channel metadata and receive real-time change events.

Requires App Context

Enable App Context for your keyset in the Admin Portal.

Update channel details

Edit channel metadata with update() or updateChannel().

Both methods produce the same result. Call update() on a Channel object or updateChannel() on the Chat object with the channel ID.

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

Parameter	Required 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

Type	Description
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

Receive real-time notifications when channel metadata changes or a channel is deleted:

• onUpdated() - fires when channel metadata is modified
• onDeleted() - fires when the channel is deleted

Method signature

These methods take the following parameters:

• onUpdated()

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

• onDeleted()

  1channel.onDeleted(callback: () -> Unit): AutoCloseable

Input

* required

Parameter	Description
callback (in onUpdated) * Type: (channel: Channel) -> Unit Default: n/a	Function that receives the updated Channel object when metadata changes.
callback (in onDeleted) * Type: () -> Unit Default: n/a	Function invoked when the channel is deleted.

Output

Type	Description
AutoCloseable	Interface that lets you stop receiving channel-related updates by invoking the close() method.

Sample code

Get updates when the support channel metadata changes.

1val supportChannel: Channel
2

3...
4

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

9...
10// stop receiving updates:
11subscription.close()

Get notified when the support channel is deleted.

1val supportChannel: Channel
2

3...
4

5val subscription = supportChannel.onDeleted {
6    println("Channel was deleted")
7}
8

9...
10// stop receiving updates:
11subscription.close()

Get channel updates (deprecated)

Deprecated methods

streamUpdates() is deprecated. Use onUpdated() and onDeleted() instead. streamUpdatesOn() remains supported.

Receive updates when Channel objects are edited or removed:

• streamUpdates() - monitors a single channel
• streamUpdatesOn() - monitors multiple channels

Both methods accept a callback invoked when channel metadata changes. They subscribe to a channel and add an objects event listener for channel events, returning an unsubscribe function.

Stream update behavior

• streamUpdates() returns the updated Channel object on each change (null if deleted)
• streamUpdatesOn() returns the complete list of monitored channels on any change

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

Parameter	Required 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

Type	Description
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    // The callback receives the entire updated Channel object each time a change occurs.
  7    if (updatedChannel != null) {
  8        println("-=Updated channel: $updatedChannel")
  9    } else {
  10        println("Channel was deleted")
  11    }
  12}
  13
  
  14...
  15// always remember to call close to stop receiving updates:
  16subscription.close()

  show all 16 lines

• 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    // The callback receives the complete list of all channels you're monitoring
  12    // each time any change occurs.
  13    println("-=Updated channels: $updatedChannels")
  14}
  15
  
  16...
  17// always remember to call close to stop receiving updates:
  18subscription.close()

  show all 18 lines