Class Service

Represents a service endpoint in an XID document.

Implements

HasPermissions
EnvelopeEncodable

Constructors

constructor

new Service(uri: string): Service
Parameters
- uri: string
Returns Service
- Defined in xid/src/service.ts:38

Methods

`Static`new

new(uri: string): Service
Create a new Service with the given URI.
Parameters
- uri: string
Returns Service
- Defined in xid/src/service.ts:50

uri

uri(): string
Get the service URI.

Returns string
- Defined in xid/src/service.ts:57

capability

capability(): string
Get the capability string.

Returns string
- Defined in xid/src/service.ts:64

setCapability

setCapability(capability: string): void
Set the capability string.
Parameters
- capability: string
Returns void
- Defined in xid/src/service.ts:71

addCapability

addCapability(capability: string): void
Add a capability, throwing if one already exists or is empty.
Parameters
- capability: string
Returns void
- Defined in xid/src/service.ts:78

keyReferences

keyReferences(): Set<string>
Get the key references set.

Returns Set<string>
- Defined in xid/src/service.ts:91

keyReferencesMut

keyReferencesMut(): Set<string>
Get the key references set for mutation.

Returns Set<string>
- Defined in xid/src/service.ts:98

addKeyReferenceHex

addKeyReferenceHex(keyReferenceHex: string): void
Add a key reference by hex string.
Parameters
- keyReferenceHex: string
Returns void
- Defined in xid/src/service.ts:105

addKeyReference

addKeyReference(keyReference: Reference): void
Add a key reference.
Parameters
- keyReference: Reference
Returns void
- Defined in xid/src/service.ts:115

delegateReferences

delegateReferences(): Set<string>
Get the delegate references set.

Returns Set<string>
- Defined in xid/src/service.ts:122

delegateReferencesMut

delegateReferencesMut(): Set<string>
Get the delegate references set for mutation.

Returns Set<string>
- Defined in xid/src/service.ts:129

addDelegateReferenceHex

addDelegateReferenceHex(delegateReferenceHex: string): void
Add a delegate reference by hex string.
Parameters
- delegateReferenceHex: string
Returns void
- Defined in xid/src/service.ts:136

addDelegateReference

addDelegateReference(delegateReference: Reference): void
Add a delegate reference.
Parameters
- delegateReference: Reference
Returns void
- Defined in xid/src/service.ts:146

name

name(): string
Get the name.

Returns string
- Defined in xid/src/service.ts:153

setName

setName(name: string): void
Set the name, throwing if one already exists or is empty.
Parameters
- name: string
Returns void
- Defined in xid/src/service.ts:160

permissions

permissions(): Permissions
Get the permissions for this object.

Returns Permissions
Implementation of HasPermissions.permissions
- Defined in xid/src/service.ts:171

permissionsMut

permissionsMut(): Permissions
Get a mutable reference to the permissions.

Returns Permissions
Implementation of HasPermissions.permissionsMut
- Defined in xid/src/service.ts:175

intoEnvelope

intoEnvelope(): Envelope$1
Convert to envelope.

Returns Envelope$1
Implementation of EnvelopeEncodable.intoEnvelope
- Defined in xid/src/service.ts:182

`Static`tryFromEnvelope

tryFromEnvelope(envelope: Envelope$1): Service
Try to extract a Service from an envelope.
Parameters
- envelope: Envelope$1
Returns Service
- Defined in xid/src/service.ts:216

equals

equals(other: Service): boolean
Check equality with another Service (based on URI).
Parameters
- other: Service
Returns boolean
- Defined in xid/src/service.ts:305

hashKey

hashKey(): string
Get a hash key for use in Sets/Maps.

Returns string
- Defined in xid/src/service.ts:312

clone

clone(): Service
Clone this Service.

Returns Service
- Defined in xid/src/service.ts:319