1018
Chapter 6: ColdFusion MX Event Gateway Reference
addBuddy
Description
Adds a buddy to the buddy list for the gateway user ID and asks to have the IM server send
messages with the buddy’s online presence state to the gateway.
Syntax
Boolean
= addBuddy(
name
,
nickname
,
group
)
See also
getBuddyInfo
,
getBuddyList
,
removeBuddy
, “Using the GatewayHelper object” in Chapter 43,
“Using the Instant Messaging Event Gateways” in
ColdFusion MX Developer’s Guide
Parameters
Returns
True if the ID was added to the gateway’s buddy list; False, otherwise.
Usage
This method adds the buddy to the buddy list for the gateway’s ID and sends a subscription
request (to automatically get presence information about the buddy’s online status) to the remote
buddy. It does not wait for a response from the buddy, so it returns True (and the gateway adds
the buddy to the list) even if the buddy denies the subscription request. Use the listener CFC
onAddBuddyResponse
method to monitor the buddy’s response. If the CFEvent.data.MESSAGE
field value is decline, the listener method can call the gatewayHelper object
removeBuddy
method
to remove the buddy from the buddy list.
Example
See “GatewayHelper example”, in Chapter 43, “Using the Instant Messaging Event Gateways” in
ColdFusion MX Developer’s Guide
, which uses all GatewayHelper class methods.
Parameter
Description
name
The unique instant messaging user name for the person about whom you want to
receive periodic status messages.
nickname
The nickname that the application can use to refer to the user.
group
The name of the group you wish to add the user to in your Buddy List. If the group
specified does not exist, it will be created. If the group parameter is the empty string,
the gateway uses the General group.
Содержание COLFUSION MX 7 - INSTALLING AND USING COLDFUSION MX
Страница 1: ...COLDFUSION MX7 CFML Reference...
Страница 20: ...20 Chapter 1 Reserved Words and Variables...
Страница 50: ...50 Chapter 2 ColdFusion Tags cfelse br Searching cfif cfloop cfif...
Страница 101: ...cfdefaultcase 101 cfdefaultcase cfswitch cfoutput Your grade is grade cfoutput...
Страница 115: ...cfdocumentsection 115 cfdocumentsection cfoutput cfdocument...
Страница 311: ...cfNTauthenticate 311 Please Try again H2 cfif cfoutput cfinclude template loginform cfm cfabort cfif cfif cflogin...
Страница 411: ...cftable 411 cftable body html...
Страница 515: ...Chr 515 maxlength 5 p input type Submit name input type RESET cfform...
Страница 605: ...GetEncoding 605 WriteOutput The encoding is theEncoding cfscript cfif...
Страница 629: ...GetProfileString 629 tr td input type Submit name Submit value Submit td td td tr table form...
Страница 655: ...IIf 655 cfoutput IIf Hour Now GTE 12 DE It is afternoon or evening DE It is morning cfoutput b...
Страница 664: ...664 Chapter 3 ColdFusion Functions cfelse h3 Conversion error h3 cfif...
Страница 687: ...IsStruct 687 cfoutput cfquery cfif cfoutput hr Employee Add Complete cfoutput cfcase cfswitch...
Страница 693: ...IsWDDX 693 struct data wddxPacket hr xmp cfoutput packet xmp IsWDDX returns IsWDDX packet br cfoutput...
Страница 751: ...LSDateFormat 751 hr noshade cfoutput cfloop...
Страница 861: ...StructFind 861 cfquery cfif cfoutput hr Employee Add Complete cfoutput cfcase cfswitch...
Страница 869: ...StructIsEmpty 869 cfoutput cfquery cfif cfoutput hr Employee Add Complete cfoutput cfcase cfswitch...
Страница 903: ...Val 903 value Is the beginning numeric name form...
Страница 932: ...932 Chapter 3 ColdFusion Functions...
Страница 944: ...944 Chapter 4 ColdFusion MX Flash Form Style Reference...
Страница 962: ...962 Chapter 5 Application CFC Reference...
Страница 1008: ...1008 Chapter 6 ColdFusion MX Event Gateway Reference cfset retValue Reason reason cfreturn retValue cffunction...
Страница 1054: ...1054 Chapter 6 ColdFusion MX Event Gateway Reference...