new RoleInstance(version, payload, serviceSid, sid)
Initialize the RoleContext
Parameters:
Name | Type | Description |
---|---|---|
version |
V2 | Version of the resource |
payload |
RolePayload | The instance payload |
serviceSid |
sid | The service_sid |
sid |
sid | The sid |
Properties:
Name | Type | Description |
---|---|---|
sid |
string | The sid |
accountSid |
string | The account_sid |
serviceSid |
string | The service_sid |
friendlyName |
string | The friendly_name |
type |
role.role_type | The type |
permissions |
string | The permissions |
dateCreated |
Date | The date_created |
dateUpdated |
Date | The date_updated |
url |
string | The url |
Methods
fetch(callbackopt) → {Promise}
fetch a RoleInstance
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
callback |
function |
<optional> |
Callback to handle processed record |
Returns:
Resolves to processed RoleInstance
- Type
- Promise
remove(callbackopt) → {Promise}
remove a RoleInstance
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
callback |
function |
<optional> |
Callback to handle processed record |
Returns:
Resolves to processed RoleInstance
- Type
- Promise
toJSON()
Provide a user-friendly representation
Returns:
Object
update(opts, callbackopt) → {Promise}
update a RoleInstance
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
opts |
object | Options for request
Properties
|
|||||||
callback |
function |
<optional> |
Callback to handle processed record |
Returns:
Resolves to processed RoleInstance
- Type
- Promise