Class: SCIMMY.Messages.ListResponse
SCIM List Response Message
Description
Summary:
- Formats supplied service provider resources as ListResponse messages, handling pagination and sort when required.
The ListResponse class creates a SCIM ListResponse message for a supplied set of resources, and automates pagination and sorting of the included set.
It is used internally by the read() method in each of SCIMMY's Resource classes when requesting a list of resources matching a given query,
and in the apply() instance method of the SearchRequest message class.
Tip:
When using theUserandGroupresource classes, their instanceread()methods will wrap the set of matching query results in aListResponseinstance. This happens automatically when retrieving multiple resources, meaning their egress handlers need only return the array of matching resources, not aListResponseinstance of their own.
Usage
Instantiate a new SCIM List Response Message with relevant details
new SCIMMY.Messages.ListResponse(request, paramsopt)
Parameters:
| Name | Type | Description | ||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request
|
SCIMMY.Messages.ListResponse
SCIMMY.Types.Schema[]
|
contents of the ListResponse message, or items to include in the list response |
||||||||||||||||||||||||||||
paramsopt
|
~ListConstraints
|
parameters for the list response (i.e. sort details, start index, and items per page) Properties
|
Properties:
| Name | Type | Description |
|---|---|---|
schemas
|
SCIMMY.Messages.ListResponse.id[]
|
list exclusively containing the SCIM ListResponse message schema ID |
Resources
|
SCIMMY.Types.Schema[]
|
resources included in the list response |
totalResults
|
Number
|
the total number of resources matching a given request |
startIndex
|
Number
|
index within total results that included resources start from |
itemsPerPage
|
Number
|
maximum number of items returned in this list response |
Examples:
// Retrieve the list of resources from somewhere, and pass it to the ListResponse constructor
const resources = [{id: "1", userName: "AdeleV"}, {id: "2", userName: "GradyA"}];
const response = new SCIMMY.Messages.ListResponse(resources);// Retrieve the list of resources from somewhere...
const resources = [{id: "1", userName: "AdeleV"}, {id: "2", userName: "GradyA"}];
// ...and separately retrieve the total number of matching results
const totalResults = 1005;
// Instantiate the list response with the resources array, specifying totalResults
const response = new SCIMMY.Messages.ListResponse(resources, {totalResults});// Retrieve the list of resources from somewhere...
const resources = [{id: "1", userName: "AdeleV"}, {id: "2", userName: "GradyA"}];
// ...and set the length of the list to match the desired total
resources.length = 1005;
// Instantiate the list response with the (mostly) sparse resources array
const response = new SCIMMY.Messages.ListResponse(resources, {itemsPerPage: 2});Members
(static) id: "urn:ietf:params:scim:api:messages:2.0:ListResponse"
SCIM List Response Message Schema ID
- Type:
- {"urn:ietf:params:scim:api:messages:2.0:ListResponse"}
Type Definitions
ListConstraints
ListResponse sort and pagination constraints
- Type:
- {Object}
Properties:
| Name | Type | Default | Description |
|---|---|---|---|
sortByopt
|
String
|
|
the attribute to sort results by, if any |
sortOrderopt
|
String
|
|
the direction to sort results in, if sortBy is specified |
startIndexopt
|
Number
|
|
offset index that items start from |
countopt
|
Number
|
|
maximum number of items returned in this list response |