Service -
ApplicationIcon
- Class
- VMware.Hv.ApplicationIcon
- See also
-
ApplicationIconId, ApplicationIconInfo, ApplicationIconSpec, ApplicationIconSummaryView, 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
ApplicationIcon_CreateAndAssociate
Creates a new ApplicationIcon and associates it with application(s) mentioned in
the spec. Any existing ApplicatonIcon association will be replaced with the newly
supplied association information for application(s) specified in the spec.
This API throws an exception if executionData contains an empty applications field.
Privileges
Privilege
|
Description
|
POOL_MANAGEMENT |
privilege is required to create ApplicationIcon.
|
FEDERATED_LDAP_MANAGE |
privilege is required if Application has
Global Application Entitlement.
|
Parameters
Return Value
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. |
Events
Event
|
Description
|
VLSI_APPLICATION_ICON_CREATED_ASSOCIATED |
if ApplicationIcon is created
and associated with all the applications specified in spec.
|
VLSI_APPLICATION_ICON_CREATE_ASSOCIATE_FAILED |
if operation failed.
|
Show WSDL type definition
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
Return Value
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
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.
If there is a customized icon association for the given application, it will always
return customized icon only.
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
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
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
ApplicationIcon_GetSummaryViewByApplications
List summaries of all ApplicationIcons used by the given Application entityIDs
without the image data. If an Application has multiple icons, the summary of the
icon with the closest size matching height and width is chosen.
If there is a customized icon association for the given application, it will always
return customized icon summary only.
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 ApplicationIconSummaryViews
are being requested.
|
Return Value
Type
|
Description
|
ApplicationIconSummaryView[] | The array of ApplicationIconSummaryViews 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) ApplicationIconSummaryViews for applications that have at least one icon, and thus return a matching icon summary 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
ApplicationIcon_RemoveAssociations
Removes association between ApplicationIcon and Application(s). It deletes the ApplicationIcon
if not used by any other Applications. This operation is only allowed on customized
icons i.e. ApplicationIcons having iconSource as unset cannot be removed.
Privileges
Privilege
|
Description
|
POOL_MANAGEMENT |
privilege is required to delete the icon associations.
|
FEDERATED_LDAP_MANAGE |
privilege is required if Application has
Global Application Entitlement.
|
Parameters
Return Value
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. |
Events
Event
|
Description
|
VLSI_APPLICATION_ICON_ASSOCIATION_REMOVED |
if association is removed between
ApplicationIcon and all the Application(s).
|
VLSI_APPLICATION_ICON_ASSOCIATION_REMOVE_FAILED |
if failed in removing association
between any Application and ApplicationIcon.
|
Show WSDL type definition
ApplicationIcon_UpdateAssociations
Updates an association between this ApplicationIcon and Application(s).
This operation is only allowed on customized icons i.e. ApplicationIcons
having iconSource as unset cannot be removed.
Privileges
Privilege
|
Description
|
POOL_MANAGEMENT |
privilege is required to update any attributes.
|
FEDERATED_LDAP_MANAGE |
privilege is required if Application has
Global Application Entitlement.
|
Parameters
Return Value
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. |
Events
Event
|
Description
|
VLSI_APPLICATION_ICON_ASSOCIATION_UPDATED |
if ApplicationIcon is
associated with all the applications specified.
|
VLSI_APPLICATION_ICON_ASSOCIATION_UPDATE_FAILED |
if the ApplicationIcon update
failed.
|
Show WSDL type definition
© 2021 VMware, Inc. All rights reserved.
Revision Nov-2021 Version 8.4.0