Copyright © Cloud Software Group, Inc. All Rights Reserved

AmiSession::get... Accessors

Method

Declarations

AmiStatus getName(const char ** name) const;

 

AmiStatus getDisplayName(const char ** displayName) const;

 

AmiStatus getHelp(const char ** help) const;

 

AmiStatus getUserData(void ** userData) const;

 

AmiStatus& getStatus();

Purpose

Accessors for AmiSession objects.

Methods

The following table lists the get accessors for AmiSession objects.

Method	Description
getName()	Gets the name of this microagent. This name can be different from the display name, as this is the actual name by which the microagent is identified in the TIBCO Hawk system.
getDisplayName()	Gets the display name of the microagent. This is the name as it appears and can be different from the actual name of the microagent. The display name is the user-friendly name by which this interface is to be known, as opposed to the internal interface identifier. The TIBCO Hawk WebConsole shows the display name in the list of discovered microagents/AMI applications.
getHelp()	Gets the help text of this microagent. The returned help text is the optional help text that is displayed to the user.
getUserData()	Returns the user data in the specified AMI session.
getStatus()	Used to check that the session has been created correctly.

 

 

Copyright © Cloud Software Group, Inc. All Rights Reserved