io.agora.rtm.RtmAttribute Class Reference

Public Member Functions
	RtmAttribute (String key, String value)
void	setKey (String key)
String	getKey ()
void	setValue (String value)
String	getValue ()
String	toString ()

Detailed Description

A class for setting and getting the RtmAttribute.

Constructor & Destructor Documentation

RtmAttribute()

io.agora.rtm.RtmAttribute.RtmAttribute	(	String	key,
		String	value
	)

The construction method of RtmAttribute.

Parameters

key	The attribute name. Must be visible characters and not exceed 32 Bytes in length.
value	The attribute value. Must not exceed 8 KB in length.

Member Function Documentation

setKey()

void io.agora.rtm.RtmAttribute.setKey

(

String

key

)

Sets the attribute name.

Parameters

key	The attribute name. Must be visible characters and not exceed 32 Bytes in length.

getKey()

String io.agora.rtm.RtmAttribute.getKey

(

)

Gets the attribute name.

Returns

The attribute name that is set using the setKey method.

setValue()

void io.agora.rtm.RtmAttribute.setValue

(

String

value

)

Sets the attribute value.

Parameters

value

The attribute value. Must not exceed 8 KB in length.

getValue()

String io.agora.rtm.RtmAttribute.getValue

(

)

Gets the attribute value.

Returns

The attribute value that is set using the setValue method.