IGHARemoteObject Interface |
Defines the GHA Remote object
Namespace: RemoteRESTLib
Assembly: GHARemoteRESTLib (in GHARemoteRESTLib.dll) Version: 1.0.14
SyntaxThe IGHARemoteObject type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | Class |
Class name of the GHA Object
|
| Description |
Free form description of the object
|
| DisplayName |
Optional display name of the GHA object. Used by UI's in-lieu of the simplename
|
| Name |
Simple name of the GHA Object
|
| Navigation |
Desired navigation behavior of the GHA Object. Used by UI's to determine if the object should be displayed
|
| ObjectID |
Unique identifier of the GHA Object
|
| Parent |
Path to the parent of the GHA object
|
| Path |
Full path of the GHA Object
|
Methods| Name | Description | |
|---|---|---|
 | AddToGroup |
Adds this instance to the specified group. Creates the group if it does not exist
|
| CreateObjectAsync |
Creates an object of the specified class name as a child of the calling object
|
| DeleteObjectAsync |
Deletes a child object of the calling object matching the specified name
|
| GetBindableObjectsAsync |
Returns objects implementing the IBindable interface
|
| GetCapabilitiesAsync |
Returns all capabilities currently defined by GHA
|
| GetChildrenAsync |
Returns a collection of objects containing the children of the calling object, optionally done recursively and sorted
|
| GetCompatibleGroups |
Returns groups that have members compatible with the calling object
|
| GetContainedTypesAsync |
Returns the types that can be children for the owning object
|
| GetGroupingCompatibleObjects |
Returns objects that are groupable and of the same type as the calling object
|
| GetGroupMemberships |
Gets the groups of which this instance is a member
|
| GetInheritedClassesAsync |
Returns the inheritance tree for the specified class
|
| GetObjectAsync(Guid) |
Returns the object with the requested Object ID
|
| GetObjectAsync(String) |
Returns an object at the specified absolute Uri
|
| GetObjectsByPropertyNameAsync |
Returns a collection of child objects that have the specified property
|
| GetObjectsByPropertySearchAsync |
Returns a collection of objects that contain properties that match the specified search string
|
| GetObjectsByPropertyValueAsync |
Returns a collection of objects that have the specified property and match the specified value
|
| GetObjectsByTypeAndPropertyValueAsync |
Returns a collection of objects of the specified type containing the specified property and matches the property value
|
| GetObjectsByTypeAsync |
Returns objects of the specified type
|
| GetPlaylistItemsAsync |
Returns playlist items from a playlist container
|
| GetPropertiesAsync |
Returns a list of Property descriptors for the calling object
|
| GetPropertyNamesAsync |
Returns a list of the calling object's property names
|
| GetRemoteEnumerationsAsync |
Returns all enumeration types defined in GHA
|
| GetTypesWithCategoryAsync |
Returns types tagged with the specified category
|
| GetValueAsync |
Returns the value of the specified property
|
| HasChildrenAsync |
Determines if the object has children. More efficient than downloading children and then checking
|
| InvokeAsync |
Returns the value of the specified property
|
| IsChildOfAsync |
Determines if the specified object is one of the calling object's children
|
| IsOfExplicitTypeAsync |
Determines if the calling object inherits from the specified class
|
| RemoveFromGroup |
Removes this instance from the specified group. Deletes the group if empty
|
| RenameAsync | |
| RunCommandAsync |
Invoke the specified method of the calling object
|
| SetValueAsync(String, Object) |
Sets the specified property to the specified value
|
| SetValueAsync(String, Object, Int32) |
Internal use only
|
| SetValueForcedAsync |
Performs the standard SetValue but also triggers the PropertyChanged handler regardless of whether the
property has changed or not
|
| SubscribeToCreateAsync | |
| SubscribeToDeleteAsync |
Subscribes to the Delete object event for the object. Invokes event handler if a child object is deleted under the owning object.
|
| SubscribeToPropertyAsync |
Subscribes to any changes to the specified property
|
| UnSubscribeAsync |
Unsubscribes from the specified subscription (property change, create, or delete)
|
See Also