JavaScript
User Channel Metadata

User & Channel Metadata

With metadata and metacounter which consist of key-value items, you can store additional information to users and channels. This page explains how to manage user metadata, channel metadata, and channel metacounter.

Note : User metadata, 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 user metadata and 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 an Integer.


User metadata

You can store additional information to users such as phone number, email or a long description of a user with user metadata, which can be fetched or rendered into the UI. A user metadata is a Dictionary and it can be stored into a User object.

Create

To store a user metadata into a User object, create a Dictionary of key-value items, and then pass it as a parameter when calling the createMetaData() method. You can put multiple key-value items in the dictionary.

Light Color Skin
Copy
var data = {
    'key1': 'value1',
    'key2': 'value2'
};

var user = sb.currentUser;
user.createMetaData(data, function(metadata, error) {
    if (error) {
        return;
    }
});

Update

The procedure to update a user metadata is the same as creating a user metadata. Values of existing keys will be updated and values of new keys will be added.

Light Color Skin
Copy
var data = {
    'key1': 'valueToUpdate1',
    'key2': 'valueToUpdate2'
};

var user = sb.currentUser;
user.updateMetaData(data, function(metadata, error) {
    if (error) {
        return;
    }
});

Retrieve

You can retrieve user metadata by reading the metadata property of a User object.

Light Color Skin
Copy
var user = sb.currentUser;
var value1 = user.metaData['key1'];

Delete

You can delete a user metadata as below.

Light Color Skin
Copy
var user = sb.currentUser;
user.deleteMetaData('key1', function(response, error) {
    if (error) {
        return;
    }
});

Channel metadata

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 and it can be stored into a Channel object.

Create

To store a channel metadata into a Channel object, create a Dictionary of key-value items that the key and value are String, and then pass it as a parameter when calling the createMetaData() method. You can put multiple key-value items in the dictionary.

Light Color Skin
Copy
var data = {
    'key1': 'value1',
    'key2': 'value2'
};

channel.createMetaData(data, function(response, error) {
    if (error) {
        return;
    }
});

Update

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.

Light Color Skin
Copy
var data = {
    'key1': 'valueToUpdate1',   // Update an existing item with a new value.
    'key2': 'valueToUpdate2',   // Update an existing item with a new value.
    'key3': 'valueToAdd3'       // Add a new key-value item.
};

var upsertIfNotExist = true;    // If false, the item with `key3` isn't added to the metadat metadata. 

channel.updateMetaData(data, upsertIfNotExist, function(response, error) {
    if (error) {
        return;
    }
});

Retrieve

You can retrieve channel metadata by creating a Collection of keys to retrieve and passing it to the getMetaData() method as a parameter. A Dictionary will return through the callback method with corresponding key-value items.

Light Color Skin
Copy
var keys = [ 
    'key1',
    'key2'
];

channel.getMetaData(keys, function(response, error) {
    if (error) {
        return;
    }
});

Delete

You can delete a channel metadata as below.

Light Color Skin
Copy
channel.deleteMetaData('key1', function(response, error) {
    if (error) {
        return;
    }
});

Channel metacounter

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 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.

Create

To store a metacounter into a channel, create a Dictionary of key-value items that the key is String and the value is Integer, and then pass it as a parameter when calling the createMetaCounters() method. You can store multiple key-value items in the dictionary.

Light Color Skin
Copy
var counters = {
    'key1': 1,
    'key2': 2'
};

channel.createMetaCounters(counters, function(response, error) {
    if (error) {
        return;
    }
});

Update

The procedure to update a channel metacounter is the same as creating a channel metacounter. Values of existing keys will be updated and values of new keys will be added.

Light Color Skin
Copy
var data = {
    'key1': 3,  // Update 1 to 3.
    'key2': 4,  // Update 2 to 4.
    'key3': 0   // Add a new key-value item.
};

var upsertIfNotExist = true;    // If false, the item with `key3` isn't added to the metadat metadata. 

channel.updateMetaCounters(data, upsertIfNotExist, function(response, error) {
    if (error) {
        return;
    }
});

Increase

You can increase values in a channel metacounter by passing a Dictionary of keys to increase as a parameter to the increaseMetaCounters() method. The values of corresponding keys in the metacounter will be incremented by the number you’ve specified.

Light Color Skin
Copy
var counters = {
    'key1': 2,  // Increase by 2.
    'key2': 3'  // Increase by 3.
};

channel.increaseMetaCounters(counters, function(response, error) {
    if (error) {
        return;
    }
});

Decrease

You can decrease values in a channel metacounter by passing a Dictionary of keys to decrease as a parameter to the decreaseMetaCounters() method. The values of corresponding keys in the metacounter will be decremented by the number you’ve specified.

Light Color Skin
Copy
var counters = {
    'key1': 3,  // Decrease by 3.
    'key2': 4'  // Decrease by 4.
};

channel.decreaseMetaCounters(counters, function(response, error) {
    if (error) {
        return;
    }
});

Retrieve

You can retrieve channel metacounter by creating a Collection of keys to retrieve and passing it as a parameter to the getMetaCounters() method. A Dictionary will return through the callback method with corresponding key-value items.

Light Color Skin
Copy
var keys = [ 
    'key1',
    'key2'
];

channel.getMetaCounters(keys, function(response, error) {
    if (error) {
        return;
    }
});

Delete

You can delete a channel metacounter as below.

Light Color Skin
Copy
channel.deleteMetaCounter('key1', function(response, error) {
    if (error) {
        return;
    }
});