SCIMMY 1.3.3

Class: SCIMMY.Messages.ListResponse

View Source on GitHub

Class: SCIMMY.Messages.ListResponse

SCIM List Response Message

Summary:
  • Formats supplied service provider resources as ListResponse messages, handling pagination and sort when required.

Usage

Instantiate a new SCIM List Response Message with relevant details

                    
                        new SCIMMY.Messages.ListResponse(request, paramsopt)
Source:
src/lib/messages/listresponse.js, line 7
Parameters:
Name Type Description
request Object 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
Name Type Default Description
countopt Number 
                        20

alias property for itemsPerPage, used only if itemsPerPage is unset
itemsPerPageopt Number 
                        20

maximum number of items returned in this list response
Properties:
Name Type Description
Resources (Object|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

Type Definitions

ListConstraints

ListResponse sort and pagination constraints

Type:
{Object}
Source:
src/lib/messages/listresponse.js, line 15
Properties:
Name Type Default Description
sortByopt String

the attribute to sort results by, if any
sortOrderopt String 
                        "ascending"

the direction to sort results in, if sortBy is specified
startIndexopt Number 
                        1

offset index that items start from
countopt Number 
                        20

maximum number of items returned in this list response