Skip to content
Delegates
ItemDelegate
ItemDelegate
Name
description
parameters
parameter type
parameter description
Name
description
parameters
parameter type
parameter description
parent
1
returns a delegate for the parent
1
none
getGroup
1
returns the group of the item.
1
none
child
1
Returns a action object for the child attribute. If the attribute is a group relationship, a GroupDelegate object is returned. If it is a one to one relationship, an ItemDelegate will be returned. If it is not a relationship, null is returned
1
attrPath
string
the path to the child
createObj
1
Creates a ApiRedux Obj, used to do most of the work
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
getDeviceByNetworkAlias
3
gets a device using its network and external id
3
networkId
string
id of the network
externalId
string
id of the device
identifier
string
alias of the network
getUrl
1
Returns the url for this group action object
1
forInterfaceUrl
boolean
get
1
Returns a redux action that will call api to read a child of the current path
1
options
object
api options
requestCanGet
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
canGet
1
Accesses whether or not a user can get an item at this path in the api from state
1
state
object
redux state
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
a set of 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
update
2
Returns a redux action that will call api to update a child of the current path
2
data
object
values of the item to be changed
options
object
api options
requestCanUpdate
2
Returns a redux action that will ask the api if you can update the item at the current path
2
query
object
query object to send to the api
body
object
the data of the update
canUpdate
1
Accesses whether or not a user can update an item at this path in the api from state
1
state
object
redux state
delete
1
Returns a redux action that will call api to delete a child of the current path
1
options
object
api options
requestCanDelete
3
Returns a redux action that will ask the api if you can delete the item at the current path
3
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
1
Accesses whether or not a user can delete an item at this path in the api from state
1
state
object
redux state
historyDelegate.get
1
none
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
users
1
Returns a Users object, used to access users with permissions on this device
1
none
user
1
Returns a User object, used to access a user with permissions on this device
1
userId
string
Id of the user
messages
1
makes an api access object for managing a device's outbound messages
1
none
goTo
1
navigates the url to the child’s path
1
attrPath
string
child relationship to navigate to
getStatus
1
gets the status of an outstanding api query for the item
1
state
object
redux state
getItem
1
retrieves the item from state
1
state
object
redux state
isLoading
1
gets the loading status from an outstanding api query for the item
1
state
object
redux state
isDone
1
gets if an api query for the item is finished
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.