services namespace

The members of the services namespace allow you to configure and implement the services in a connector.

Signature:

export declare namespace services

Introduced: API version 1.0

Interfaces

Interface	Description
IAuthenticationField	A field on an authentication dialog.
IAuthenticator	An authenticator, which provides a service with user authentication functionality.
IAuthenticatorConfig	A collection of properties that provide configuration for an authenticator.
IAuthenticatorServiceConfig	A collection of properties that define whether a service requires user authentication, and how it behaves if so.
IBooleanCondition	A condition that prompts the user for a Boolean value.
ICharLimit	A constraint on the length of a string value.
IConditionBase	A set of information that is common to all service conditions.
ICoreServiceConfig	A collection of properties that provide the name and configuration for a service.
IDateAndTimeCondition	A condition that prompts the user for a date-and-time value.
IDateCondition	A condition that prompts the user for a date value.
IDecimalCondition	A condition that prompts the user for a decimal value.
IFormSection	A section of a form for an i2 Connect service.
IFormServiceConfig	A collection of properties that define whether a service requires user input, and how that input looks.
IGeospatialAreaCondition	A condition that prompts the user for a geospatial area value.
IGeospatialCondition	A condition that prompts the user for a geospatial value.
IItemTypeConstraint	A set of constraints that apply to seeds that have a particular item type.
ILongRunningServiceConfig	A collection of properties that define whether a service involves a long-running operation.
ILongRunningState	A collection of methods through which an i2 Connect service can communicate with a user who initiated a long-running operation.
IMultiLineStringCondition	A condition that prompts the user for a multiple-line string value.
INumberCondition	A condition that prompts the user for a numeric value.
IRequestInformation	A set of information from an incoming HTTP request.
IRequiresPossibleValues	A type that indicates that a string condition can present a list of possible values.
IResult	A result from a service method on a connector for the i2 Connect server.
ISecurityPermission	A set of access levels associated with the values of a particular security dimension.
ISeedConstraints	A set of constraints on the records that can be passed as seeds to a service.
ISeededServiceConfig	A collection of properties that provide the name and configuration for a service that might have item type seed constraints.
ISeeds	A set of seed records that the i2 Connect server passes to a service method.
ISeedServiceConfig	A collection of properties that define whether a service supports seeds, and the constraints on them.
ISelectedFromCondition	A condition that prompts the user to select a value from a list.
ISemanticSeed	A semantic seed for a search operation, which contains the seed record and the semantic property values.
ISemanticSeedConstraints	A set of semantic property type constraints on the records that can be passed as seeds to a service.
ISemanticSeededServiceConfig	A collection of properties that provide the name and configuration for a service that has semantic property type seed constraints.
ISemanticSeedServiceConfig	A collection of properties that define whether a service supports seeds with semantic property type constraints.
IServiceCallbacks	A set of methods that the server calls when it uses a service.
ISingleLineStringCondition	A condition that prompts the user for a single-line string value.
IStringValidator	A constraint on the contents of a string value.
ISubstatus	A piece of information about the progress of a long-running service method call.
ISuggestedFromCondition	A condition that prompts the user to provide a value or select one from a list.
ISupportsMaxLength	A type that indicates that a string condition can impose a length constraint on values.
ISupportsStringValidation	A type that indicates that a string condition can impose a validation constraint on values.
ITimeCondition	A condition that prompts the user for a time value.
IVisualQueryServiceCallbacks	A set of methods that the server calls when it uses a visual query service.
IVisualQueryServiceConfig	A collection of properties that provide the name and configuration for a visual query service.

Type Aliases

Type Alias	Description
AccessLevel	The level of access that a user has to some data.
AuthenticationFieldType	A type for an authentication field, which can be `'text'` or `'password'`.
AuthForm	An authentication form.
BasicForm	A basic form for an i2 Connect service.
CharLimitUnits	The units to use in constraints on the length of string values.
HidePredicate	A function that determines whether a service or condition should be hidden, based on the contents of an services.IRequestInformation object that it receives.
ICondition	A condition for a service on an i2 Connect connector.
IServiceConfig	A collection of properties that provide the name and configuration for a service that might have item type seed constraints.
IServiceConfigType	The configuration information for a service on an i2 Connect connector.
RequestSpecificValue	A function that returns a value of type `T` based on the contents of an services.IRequestInformation object that it receives.
SectionedForm	A form with sections for an i2 Connect service.
SemanticPropertyTypeIds	Sets of semantic property type identifiers, keyed by strings that identify each set.
SemanticSeeds	A set of semantic seeds, keyed by the string identifiers of the constraints that they passed.
SubstatusType	A type for a piece of substatus information.