Service - ApplicationIcon

Class: VMware.Hv.ApplicationIcon
See also: ApplicationIconId, ApplicationIconInfo, ApplicationId
Since: Horizon View 6.0

Service Description

Service that represents ApplicationIcon. These are not explicitly managed by View administrator. However, the interface is required for performance reasons: while fetching Applications, icon image data is not included, and client must separately request icons.

Methods

Methods defined in this Service
ApplicationIcon_Get, ApplicationIcon_GetByApplications, ApplicationIcon_GetInfos

ApplicationIcon_Get

Get an ApplicationIcon by Id.

Privileges

Privilege	Description
POOL_VIEW	privilege is required on at-least one Application (that the ApplicationIconId represents) to get ApplicationIconInfo.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the ApplicationIcon used to make the method call.
id	ApplicationIconId	entityId of ApplicationIcon to get.

Return Value

Type	Description
ApplicationIconInfo	requested ApplicationIcon entity.

Faults

Type	Description
EntityNotFound	Thrown if any specified entity cannot be found.
InsufficientPermission	Thrown if the user does not have sufficient permission to perform the operation.
InvalidArgument	Thrown if any specified argument is invalid.
InvalidType	Thrown if the type of any specified argument is invalid.
UnexpectedFault	Thrown if an unexpected error occurs while performing the operation.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="ApplicationIcon_Get" type="vdi:ApplicationIcon_GetRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="ApplicationIcon_GetResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:ApplicationIconInfo"/>
               </sequence>
            </complexType>
         </element>

ApplicationIcon_GetByApplications

List all ApplicationIcons used by the given Application entityIDs. If an Application has multiple icons, the icon with the closest size matching height and width is chosen.

Privileges

Privilege	Description
POOL_VIEW	privilege is required for each of the Applications in ApplicationId array to get the ApplicationIconInfo array.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the ApplicationIcon used to make the method call.
height	xsd:int	Icon height.
width	xsd:int	Icon width.
ids	ApplicationId[]	Array of entityId of the Applications whose ApplicationIcons are being requested.

Return Value

Type	Description
ApplicationIconInfo[]	The array of ApplicationIcons associated with the specified Applications. The array index order matches with entityIds array.

Faults

Type	Description
EntityNotFound	Thrown if any specified entity cannot be found.
InsufficientPermission	Thrown if the user does not have sufficient permission to perform the operation.
InvalidArgument	Thrown if any specified argument is invalid.
InvalidType	Thrown if the type of any specified argument is invalid.
PartialFailureFault	Thrown if one or more Applications do not have any associated icons to select from. The PartialFailureFault contains an array of Objects. Each Object is either (a) ApplicationIconInfo for applications that have at least one icon, and thus return a matching icon or (b) EntityNotFound for applications that have no icons associated.
UnexpectedFault	Thrown if an unexpected error occurs while performing the operation.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="ApplicationIcon_GetByApplications" type="vdi:ApplicationIcon_GetByApplicationsRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="ApplicationIcon_GetByApplicationsResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:ApplicationIconInfo" minOccurs="0" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

ApplicationIcon_GetInfos

Get all ApplicationIcons for the given ApplicationIcon entityIds

Privileges

Privilege	Description
POOL_VIEW	privilege is required on at-least one Application (that each ApplicationIconId represents) to get ApplicationIconInfo.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the ApplicationIcon used to make the method call.
ids	ApplicationIconId[]	Array of entityId of the ApplicationIcon

Return Value

Type	Description
ApplicationIconInfo[]	The list of ApplicationIcons associated with the specified ApplicationIcon entityIDs

Faults

Type	Description
EntityNotFound	Thrown if any specified entity cannot be found.
InsufficientPermission	Thrown if the user does not have sufficient permission to perform the operation.
InvalidArgument	Thrown if any specified argument is invalid.
InvalidType	Thrown if the type of any specified argument is invalid.
UnexpectedFault	Thrown if an unexpected error occurs while performing the operation.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="ApplicationIcon_GetInfos" type="vdi:ApplicationIcon_GetInfosRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="ApplicationIcon_GetInfosResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:ApplicationIconInfo" minOccurs="0" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

View API

Service - ApplicationIcon

Service Description

ApplicationIcon_Get

ApplicationIcon_GetByApplications

ApplicationIcon_GetInfos