Skip to content
Delegates
GroupDelegate
GroupDelegate
Name
description
parameters
parameter type
parameter description
Name
description
parameters
parameter type
parameter description
getGroup
1
returns the instance of the delegate
1
none
getInterfaceUrl
1
Returns the url for the interface for this action, resolved to reference the ids supplied by the patch object. This will include the systemId.
1
none
getParentInterfaceUrl
1
The inteface url to the parent, which will be an item url
1
none
getUrl
1
Returns the url for this group action object
1
forInterfaceUrl
boolean
parent
1
Returns the parent's action object. This will return an ItemAction pointed at the parent holding this group
1
none
item
1
Creates a item action for the id in the group.
1
id
string
id of the item
itemRef
1
creates a reference to an item
1
id
string
id of the item
create
2
Returns a redux action that will call the api to create an item at the current path
2
data
object
the data of the item to create
options
object
api options
requestCanCreate
2
Returns a redux action that will ask the api if you can create an item at the current path
2
query
object
query object to send to the api
body
object
the data of the object to create
canCreate
1
Accesses whether or not a user can create an item at this path in the api from state
1
state
object
redux state
add
2
Like create, but it will use the id to add an already existing device. By default, force is set true to reparent the object
2
id
string
id of the device to add to the group
options
object
api options
getDeviceByNetworkAlias
3
gets a device based off of its network information and external id
3
networkId
string
id of the network the device belongs to
externalId
string
external id of the device to fetch
identifier
string
network alias that the id is
list
1
Create a dispatch action for a request of a list of objects
1
options
object
api options
search
2
creates a dispatch action for a request of a list of objects that has been filtered and/or sorted
2
obj
object
sort and filter conditions
options
object
api options
requestCanList
1
Returns a redux action that will ask the api if you can read the item at the current path
1
query
object
query object to send to the api
canList
1
Accesses whether or not a user can list the items at this path in the api from state
1
state
object
redux state
update
3
Returns a redux action that will call api to update a child of the current path
3
id
string
id of the item to be updated
data
object
values of the item to be changed
options
object
api options
requestCanUpdate
3
Returns a redux action that will ask the api if you can update the item at the current path
3
id
string
id of the item to ask api about updating
query
object
query object to send to the api
body
object
the data of the update
canUpdate
2
Accesses whether or not a user can update an item at this path in the api from state
2
id
string
the id of the device to test against
state
object
redux state
delete
2
Returns a redux action that will call api to delete a child of the current path
2
id
string
id of the item to be deleted
options
object
api options
requestCanDelete
4
Returns a redux action that will ask the api if you can delete the item at the current path
4
id
string
id of the item to be deleted
query
object
query object to send to the api
body
object
body of the request to test
body.deleteDevice
string
optional, if set to 'force' will delete the device and not just the relationship to it at a deep path
canDelete
2
Accesses whether or not a user can delete an item at this path in the api from state
2
id
string
the id of the device to test against
state
object
redux state
events
4
Returns a redux action that makes an api call to get the events of an object at the path
4
query
object
query.query
object
query params that the server will use
query.queryName
string
query identifier
options
object
api options
requestCanEvents
1
Returns a redux action that will ask the api if you can get events at the current path
1
query
object
query object to send to the api
canEvents
2
Accesses whether or not a user can get events at this path in the api from state
2
id
string
the id of the device to test against
state
object
redux state
isGotoAllowed
1
determines if the goTo method is allowed
1
none
goTo
1
Returns a dispatch object to go to the child's url. If id is undefined, this will push a link to the group
1
id
string
id of the child
getStatus
1
gets the status of outstanding api queries for the group
1
state
object
redux state
getList
1
gets the list of the group from state
1
state
object
redux state
isLoading
1
gets the status of outstanding api queries for the group
1
state
object
redux state
isDone
1
gets the status of the outstanding api queries for the group
1
state
object
redux state
Want to print your doc?
This is not the way.
This is not the way.
Try clicking the ⋯ next to your doc name or using a keyboard shortcut (
CtrlP
) instead.