IAccCommand Interface Reference

---

Detailed Description

The IAccCommand interface is for getting information about plugin commands.

Public Types

• enum AccCommandFlags {
    AccCommandFlags_BuddyCentric = 0x0001,
    AccCommandFlags_ActionsUi = 0x0002,
    AccCommandFlags_BuddyUi = 0x0004,
    AccCommandFlags_GroupUi = 0x0008,
    AccCommandFlags_ImSessionUi = 0x0010,
    AccCommandFlags_PreferencesUi = 0x0020,
    AccCommandFlags_AboutUi = 0x0040,
    AccCommandFlags_PresenceUi = 0x0080,
    AccCommandFlags_UninstallUi = 0x0100
  }
• enum AccCommandProp {
    AccCommandProp_Id,
    AccCommandProp_Text,
    AccCommandProp_SmallIconUrl,
    AccCommandProp_Flags,
    AccCommandProp_ParentId
  }
• typedef enum IAccCommand::AccCommandFlags AccCommandFlags
• typedef enum IAccCommand::AccCommandProp AccCommandProp

Public Member Functions

• HRESULT QueryStatus ([in] xp_kvariant names,[out, retval] xp_vbool *enabled)
• HRESULT Exec ([in] xp_kvariant names)

Properties

• xp_int Id [get]
• xp_variant Property ([in] AccCommandProp property) [get]
• xp_kvariant Property ([in] AccCommandProp property) [set]

---

Member Typedef Documentation

typedef enum IAccCommand::AccCommandFlags IAccCommand::AccCommandFlags

Values for AccCommandProp_Flags. If both AccCommandFlags_BuddyUi and AccCommandFlags_GroupUi are set and the UI selection contains both buddies and groups, clients should pass only user names to QueryStatus() and Exec(). Clients should never pass a mix of both user and group names.

typedef enum IAccCommand::AccCommandProp IAccCommand::AccCommandProp

Properties for the Property method.

---

Member Enumeration Documentation

enum IAccCommand::AccCommandFlags

Values for AccCommandProp_Flags. If both AccCommandFlags_BuddyUi and AccCommandFlags_GroupUi are set and the UI selection contains both buddies and groups, clients should pass only user names to QueryStatus() and Exec(). Clients should never pass a mix of both user and group names.

Enumerator:

AccCommandFlags_BuddyCentric
AccCommandFlags_ActionsUi
AccCommandFlags_BuddyUi
AccCommandFlags_GroupUi
AccCommandFlags_ImSessionUi
AccCommandFlags_PreferencesUi
AccCommandFlags_AboutUi
AccCommandFlags_PresenceUi
AccCommandFlags_UninstallUi

enum IAccCommand::AccCommandProp

Properties for the Property method.

Enumerator:

AccCommandProp_Id	The id for the command [get] xp_int*
AccCommandProp_Text	The text for the command [get] xp_str* [put] xp_kstr
AccCommandProp_SmallIconUrl	The URL for an icon to display with the command [get] xp_str* [put] xp_kstr
AccCommandProp_Flags	The flags for the Command, from AccCommandFlags [get] xp_u32* [put] xp_u32
AccCommandProp_ParentId	The parent id for the command. If not -1, this command is associated in UI with its parent command (e.g., in a submenu). [get] xp_int* [put] xp_int

---

Member Function Documentation

HRESULT IAccCommand::QueryStatus	(	[in] xp_kvariant	names,
		[out, retval] xp_vbool *	enabled
	)

Indicates whether this command could be executed on specified users or groups. If an error is returned, or "enabled" is false, the command would not be allowed, so it should be disabled in the user interface. If AccCommandFlags_GroupUi is set, "names" should contain group names; otherwise, it should contain user names.

HRESULT IAccCommand::Exec

(

[in] xp_kvariant

names

)

Executes the command on the specified users or groups. If AccCommandFlags_GroupUi is set, "names" should contain group names; otherwise, it should contain user names.

---

Property Documentation

xp_int IAccCommand::Id [get]

Gets command id.

xp_variant IAccCommand::Property( [in] AccCommandProp property)

(

[in] AccCommandProp

property

)

[get]

Gets the specified property for a command.

xp_kvariant IAccCommand::Property( [in] AccCommandProp property)

(

[in] AccCommandProp

property

)

[set]

Sets the specified property for a command.

---