With metadata and metacounter which consist of key-value items, you can store additional information to channels. This page explains how to manage channel metadata and channel metacounter.
Note : Channel metadata and channel metacounter can each have up to 5 key-value items. The key’s length must be no larger than 128 characters. For channel metadata, the value must be a
String
and its length must be no larger than 190 characters. For channel metacounter, the value must be anInteger
.
You can store additional information to channels such as background color or a long description of a channel with channel metadata, which can be fetched or rendered into the UI. A channel metadata is a Dictionary<String, String>
and it can be stored into a Channel
object.
To store a channel metadata into a Channel
object, create a Dictionary<String, String>
of key-value items that the key and value are String
, and then pass it as an argument to a parameter when calling the CreateMetaData()
method. You can put multiple key-value items in the dictionary.
The procedure to update a channel metadata is the same as creating a channel metadata. Values of existing keys will be updated and values of new keys will be added.
You can retrieve channel metadata by creating a List
of keys to retrieve and passing it as an argument to a parameter in the GetMetaData()
method. A Dictionary<String, String>
will return through the callback method with corresponding key-value items.
You can store additional information to channels such as the tracking number of likes with channel metacounter, which can be fetched or rendered into the UI. A channel metacounter is a Dictionary<String, Integer>
and it can be stored into a Channel
object.
Note : A channel metacounter is primarily used to track and update discrete indicators in a channel. Use channel metacounter instead of channel metadata when you need an integer with atomic increasing and decreasing operations.
To store a metacounter into a channel, create a Dictionary<String, Integer>
of key-value items that the key is String
and the value is Integer
, and then pass it as an argument to a parameter when calling the CreateMetaCounters()
method. You can store multiple key-value items in the dictionary.
You can increase values in a channel metacounter by passing a Dictionary
of keys to increase as an argument to a parameter in the IncreaseMetaCounters()
method. The values of corresponding keys in the metacounter will be incremented by the number you’ve specified.
You can decrease values in a channel metacounter by passing a Dictionary
of keys to decrease as an argument to a parameter in the DecreaseMetaCounters()
method. The values of corresponding keys in the metacounter will be decremented by the number you’ve specified.
You can retrieve channel metacounter by creating a List
of keys to retrieve and passing it as an argument to a parameter in the GetMetaCounters()
method. A Dictionary<String, Integer>
will return through the callback method with corresponding key-value items.