Class PropertiesAdmin`Abstract`

Provides remote access to the properties of a communicator.

Hierarchy (View Summary)

Object
- PropertiesAdmin

Index

Constructors

Methods

dispatch getPropertiesForPrefix getProperty ice_id ice_ids ice_isA ice_ping setProperties ice_staticId

Constructors

constructor

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

Methods

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`getPropertiesForPrefix

getPropertiesForPrefix(
prefix: string,
current: Current,
): Map<string, string> | PromiseLike<Map<string, string>>
Gets all properties whose keys begin with prefix. If prefix is the empty string then all properties are returned.
Parameters
- prefix: string
  The prefix to search for. May be empty.
- current: Current
  The Current object for the dispatch.
Returns Map<string, string> | PromiseLike<Map<string, string>>
A promise like object representing the result of the dispatch, which resolves to:
- Map<string, string> : The matching property set.

`Abstract`getProperty

getProperty(key: string, current: Current): string | PromiseLike<string>
Gets a property by key.
Parameters
- key: string
  The property key.
- current: Current
  The Current object for the dispatch.
Returns string | PromiseLike<string>
A promise like object representing the result of the dispatch, which resolves to:
- string : The property value. This value is empty if the property is not 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`setProperties

setProperties(
newProperties: Map<string, string>,
current: Current,
): void | PromiseLike<void>
Updates the communicator's properties with the given property set. If an entry in newProperties matches the name of an existing property, that property's value is replaced with the new value. If the new value is the empty string, the property is removed. Existing properties that are not modified or removed by the entries in newProperties are not affected by this update.
Parameters
- newProperties: Map<string, string>
  Properties to add, change, or 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 "::Ice::PropertiesAdmin".

Overrides Object.ice_staticId