Class google.gdata.Im

Object
   |
   +--google.gdata.Im

class google.gdata.Im

Describes an instant messaging address.
Defined in gdata.js

Field Detail

address

{string|undefined} address

IM address. This attribute is required.

label

{string|undefined} label

Label. This attribute is optional.

primary

{string|undefined} primary

Whether this is the primary instant messaging address. This attribute is optional.

protocol

{string|undefined} protocol

Im protocol. This attribute is optional.

rel

{string|undefined} rel

Im type. This attribute is optional.

PROTOCOL_AIM

<static> <final> {string} PROTOCOL_AIM

AIM.

PROTOCOL_GOOGLE_TALK

<static> <final> {string} PROTOCOL_GOOGLE_TALK

Google Talk.

PROTOCOL_ICQ

<static> <final> {string} PROTOCOL_ICQ

ICQ.

PROTOCOL_JABBER

<static> <final> {string} PROTOCOL_JABBER

Jabber.

PROTOCOL_MSN

<static> <final> {string} PROTOCOL_MSN

MSN.

PROTOCOL_QQ

<static> <final> {string} PROTOCOL_QQ

Tencent QQ.

PROTOCOL_SKYPE

<static> <final> {string} PROTOCOL_SKYPE

Skype.

PROTOCOL_YAHOO

<static> <final> {string} PROTOCOL_YAHOO

Yahoo.

REL_HOME

<static> <final> {string} REL_HOME

Home instant messaging address.

REL_OTHER

<static> <final> {string} REL_OTHER

Other instant messaging address.

REL_WORK

<static> <final> {string} REL_WORK

Work instant messaging address.

google.gdata.Im

google.gdata.Im(<Object> opt_params)

Constructs an instant messaging address using an object parameter whose property names match the setter method to use for each property.

Parameters:
opt_params - Optional parameters, each of which is used as the sole parameter to the associated setter method: address, label, primary, protocol, and rel.

getAddress

string|undefined getAddress()

Returns the IM address. This attribute is required.

Returns:
IM address or undefined for none.

getLabel

string|undefined getLabel()

Returns the label. This attribute is optional.

Returns:
Label or undefined for none.

getPrimary

boolean|undefined getPrimary()

Returns whether this is the primary instant messaging address. This attribute is optional.

Returns:
Whether this is the primary instant messaging address or undefined for none.

getProtocol

string|undefined getProtocol()

Returns the im protocol. This attribute is optional.

Returns:
Im protocol or undefined for none.

getRel

string|undefined getRel()

Returns the im type. This attribute is optional.

Returns:
Im type or undefined for none.

setAddress

void setAddress(<string|undefined> address)

Sets the IM address. This attribute is required.

Parameters:
address - IM address or undefined for none.

setLabel

void setLabel(<string|undefined> label)

Sets the label. This attribute is optional.

Parameters:
label - Label or undefined for none.

setPrimary

void setPrimary(<boolean|undefined> primary)

Sets whether this is the primary instant messaging address. This attribute is optional.

Parameters:
primary - Whether this is the primary instant messaging address or undefined for none.

setProtocol

void setProtocol(<string|undefined> protocol)

Sets the im protocol. This attribute is optional.

Parameters:
protocol - Im protocol or undefined for none.

setRel

void setRel(<string|undefined> rel)

Sets the im type. This attribute is optional.

Parameters:
rel - Im type or undefined for none.