agora::rtm::IRtmChannelAttribute Class Reference

#include <IAgoraRtmService.h>

Public Member Functions
virtual void	setKey (const char *key)=0
virtual const char *	getKey () const =0
virtual void	setValue (const char *value)=0
virtual const char *	getValue () const =0
virtual const char *	getLastUpdateUserId () const =0
virtual long long	getLastUpdateTs () const =0
virtual void	release ()=0

Protected Member Functions
virtual	~IRtmChannelAttribute ()

Constructor & Destructor Documentation

~IRtmChannelAttribute()

virtual agora::rtm::IRtmChannelAttribute::~IRtmChannelAttribute ( )

inlineprotectedvirtual

Member Function Documentation

setKey()

virtual void agora::rtm::IRtmChannelAttribute::setKey ( const char *  key )

pure virtual

Sets the key of the channel attribute.

Parameters

key	Key of channel attribute. Must be visible characters and not exceed 32 Bytes.

getKey()

virtual const char * agora::rtm::IRtmChannelAttribute::getKey ( ) const

pure virtual

Gets the key of the channel attribute.

Returns

Key of the channel attribute.

setValue()

virtual void agora::rtm::IRtmChannelAttribute::setValue ( const char *  value )

pure virtual

Sets the value of the channel attribute.

Parameters

value

Value of the channel attribute. Must not exceed 8 KB in length.

getValue()

virtual const char * agora::rtm::IRtmChannelAttribute::getValue ( ) const

pure virtual

Gets the value of the channel attribute.

Returns

Value of the channel attribute.

getLastUpdateUserId()

virtual const char * agora::rtm::IRtmChannelAttribute::getLastUpdateUserId ( ) const

pure virtual

Gets the User ID of the user who makes the latest update to the channel attribute.

Returns

User ID of the user who makes the latest update to the channel attribute.

getLastUpdateTs()

virtual long long agora::rtm::IRtmChannelAttribute::getLastUpdateTs ( ) const

pure virtual

Gets the timestamp of when the channel attribute was last updated.

Returns

Timestamp of when the channel attribute was last updated in milliseconds.

release()

virtual void agora::rtm::IRtmChannelAttribute::release ( )

pure virtual

Release all resources used by the IRtmChannelAttribute instance.