Constructor
new SignTemplatesManager(client)
Parameters:
| Name |
Type |
Description |
client |
BoxClient
|
The Box API Client that is responsible for making calls to the API |
- Source:
Classes
- SignTemplatesManager
Methods
getAll(optionsopt, callbackopt) → {Promise.<schemas.SignTemplates>}
List Box Sign templates
Gets Box Sign templates created by a user.
Parameters:
| Name |
Type |
Attributes |
Description |
options |
object
|
<optional>
|
Options for the request
Properties
| Name |
Type |
Attributes |
Description |
marker |
string
|
<optional>
|
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires `usemarker` to be set to `true`. |
limit |
number
|
<optional>
|
The maximum number of items to return per page. |
|
callback |
function
|
<optional>
|
Passed the result if successful, error otherwise |
- Source:
Returns:
A promise resolving to the result or rejecting with an error
-
Type
-
Promise.<schemas.SignTemplates>
getAll(optionsopt, callbackopt) → {Promise.<schemas.SignTemplates>}
List Box Sign templates
Gets Box Sign templates created by a user.
Parameters:
| Name |
Type |
Attributes |
Description |
options |
object
|
<optional>
|
Options for the request
Properties
| Name |
Type |
Attributes |
Description |
marker |
string
|
<optional>
|
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires `usemarker` to be set to `true`. |
limit |
number
|
<optional>
|
The maximum number of items to return per page. |
|
callback |
function
|
<optional>
|
Passed the result if successful, error otherwise |
- Source:
Returns:
A promise resolving to the result or rejecting with an error
-
Type
-
Promise.<schemas.SignTemplates>
getById(options, callbackopt) → {Promise.<schemas.SignTemplate>}
Get Box Sign template by ID
Fetches details of a specific Box Sign template.
Parameters:
| Name |
Type |
Attributes |
Description |
options |
object
|
|
Options for the request
Properties
| Name |
Type |
Description |
template_id |
string
|
The ID of a Box Sign template. |
|
callback |
function
|
<optional>
|
Passed the result if successful, error otherwise |
- Source:
Returns:
A promise resolving to the result or rejecting with an error
-
Type
-
Promise.<schemas.SignTemplate>
getById(options, callbackopt) → {Promise.<schemas.SignTemplate>}
Get Box Sign template by ID
Fetches details of a specific Box Sign template.
Parameters:
| Name |
Type |
Attributes |
Description |
options |
object
|
|
Options for the request
Properties
| Name |
Type |
Description |
template_id |
string
|
The ID of a Box Sign template. |
|
callback |
function
|
<optional>
|
Passed the result if successful, error otherwise |
- Source:
Returns:
A promise resolving to the result or rejecting with an error
-
Type
-
Promise.<schemas.SignTemplate>