Class IdentitySet`Abstract`

Manages a set of object identity constraints on a Glacier2.SessionPrx.

See

SessionControl

Hierarchy (View Summary)

Object
- IdentitySet

Index

Constructors

Methods

add dispatch get ice_id ice_ids ice_isA ice_ping remove ice_staticId

Constructors

constructor

new IdentitySet(): IdentitySet
Returns IdentitySet
Inherited from Object.constructor

Methods

`Abstract`add

add(additions: Identity[], current: Current): void | PromiseLike<void>
Adds a sequence of Ice identities to this set of constraints. Order is not preserved and duplicates are implicitly removed.
Parameters
- additions: Identity[]
  The sequence of Ice identities to add.
- current: Current
  The Current object for the dispatch.
Returns void | PromiseLike<void>
A promise like object representing the result of the dispatch.

dispatch

dispatch(
request: IncomingRequest,
): OutgoingResponse | PromiseLike<OutgoingResponse>
Dispatches an incoming request to one of the methods of this generated class, based on the operation name carried by the request.
Parameters
- request: IncomingRequest
  The incoming request.
Returns OutgoingResponse | PromiseLike<OutgoingResponse>
The outgoing response (when the selected method returns a value), or a promise with the outgoing response (when the selected method returns a promise).

Remarks
Ice marshals any exception thrown by this method into the response.

Overrides Object.dispatch

`Abstract`get

get(current: Current): Identity[] | PromiseLike<Identity[]>
Gets a sequence of identities describing the constraints in this set.
Parameters
- current: Current
  The Current object for the dispatch.
Returns Identity[] | PromiseLike<Identity[]>
A promise like object representing the result of the dispatch, which resolves to:
- Ice.Identity[] : The sequence of Ice identities for this set.

ice_id

ice_id(current: Current): string | PromiseLike<string>
Returns the Slice type ID of the most-derived interface supported by this object.
Parameters
- current: Current
  The Current object for the invocation.
Returns string | PromiseLike<string>
The Slice type ID of the most-derived interface.

Inherited from Object.ice_id

ice_ids

ice_ids(current: Current): string[] | PromiseLike<string[]>
Returns the Slice type IDs of the interfaces supported by this object.
Parameters
- current: Current
  The Current object for the invocation.
Returns string[] | PromiseLike<string[]>
The Slice type IDs of the interfaces supported by this object, in alphabetical order.

Inherited from Object.ice_ids

ice_isA

ice_isA(typeID: string, current: Current): boolean | PromiseLike<boolean>
Tests whether this object supports a specific Slice interface.
Parameters
- typeID: string
  The type ID of the Slice interface to test against.
- current: Current
  The Current object for the invocation.
Returns boolean | PromiseLike<boolean>
True if this object has the interface specified by typeID or derives from the interface specified by typeID.

Inherited from Object.ice_isA

ice_ping

ice_ping(current: Current): void | PromiseLike<void>
Tests whether this object can be reached.
Parameters
- current: Current
  The Current object for the invocation.
Returns void | PromiseLike<void>
Inherited from Object.ice_ping

`Abstract`remove

remove(deletions: Identity[], current: Current): void | PromiseLike<void>
Removes a sequence of identities from this set of constraints. No errors are returned if an entry is not found.
Parameters
- deletions: Identity[]
  The sequence of Ice identities to remove.
- current: Current
  The Current object for the dispatch.
Returns void | PromiseLike<void>
A promise like object representing the result of the dispatch.

`Static`ice_staticId

ice_staticId(): string
Obtains the Slice type ID of this type.

Returns string
The return value is always "::Glacier2::IdentitySet".

Overrides Object.ice_staticId