Session Functions Summary

This table summarizes the AMI C API session functions. These functions are described in the following sections.

Function

Description

Page

ami_SessionCreateUsingProperties()

Creates a new AMI session using transport properties.

ami_SessionCreateUsingProperties()ami_SessionCreateUsingProperties()ami_SessionCreateUsingProperties()

ami_AddProperty()

Adds transport properties.

ami_AddProperty()

ami_SessionCreate()

Creates a new AMI session.

ami_SessionCreate()

ami_SessionDestroy()

Destroys the AMI session.

ami_SessionDestroy()

ami_SessionAnnounce()

Activates the AMI session.

ami_SessionAnnounce()

ami_SessionStop()

Stops (deactivates) the AMI session.

ami_SessionStop()

ami_SessionGetName()

Gets the name string of AMI session (microagent).

ami_SessionGetName()

ami_SessionGetDisplayName()

Get the user-friendly name string of AMI session (microagent).

ami_SessionGetDisplayName()

ami_SessionGetHelp()

Gets the descriptive text string of AMI session (microagent).

ami_SessionGetHelp()

ami_SessionGetUserData()

Returns the user data of the specified AMI session.

ami_SessionGetUserData()

ami_SessionSendData()

Returns data for the specified asynchronous method subscription.

ami_SessionSendData()

ami_SessionSendError()

Reports an error condition for the specified asynchronous method subscription.

ami_SessionSendError()

ami_SessionOnData()

Calls the ami_OnInvokeCallback function of the specified AMI asynchronous method once for each currently active subscription.

ami_SessionOnData()

ami_SessionSendUnsolicitedMsg()

Send an unsolicited message to any interested subscribers.

ami_SessionSendUnsolicitedMsg()