Class Service

A service of a XID document: a URI, key and delegate references, a capability, a name and permissions. On the wire only 'allow' permissions round-trip: the parser rejects 'deny' as the reference's does.

Implements

HasPermissions

Accessors

uri

get uri(): URI
The URI.

Returns URI
- Defined in service.ts:86

capability

get capability(): string
The capability; empty when there is none.

Returns string
- Defined in service.ts:91

keyReferences

get keyReferences(): ReadonlySet<Reference>
The key references (a copy).

Returns ReadonlySet<Reference>
- Defined in service.ts:108

delegateReferences

get delegateReferences(): ReadonlySet<Reference>
The delegate references (a copy).

Returns ReadonlySet<Reference>
- Defined in service.ts:135

name

get name(): string
The name; empty when there is none.

Returns string
- Defined in service.ts:162

permissions

get permissions(): Permissions
The permissions (live).

Returns Permissions
Implementation of HasPermissions.permissions
- Defined in service.ts:174

allow

get allow(): ReadonlySet<Privilege>
The allowed privileges (a copy).

Returns ReadonlySet<Privilege>
Implementation of HasPermissions.allow
- Defined in service.ts:179

deny

get deny(): ReadonlySet<Privilege>
The denied privileges (a copy).

Returns ReadonlySet<Privilege>
Implementation of HasPermissions.deny
- Defined in service.ts:184

Methods

`Static`from

from(uri: string | URI, __namedParameters?: ServiceInput): Service
A service at a URI (a components error for text that is not a URI); references and permissions can be added later.
Parameters
- uri: string | URI
- __namedParameters: ServiceInput = {}
Returns Service
- Defined in service.ts:66

setCapability

setCapability(capability: string): void
Sets (or clears, with "") the capability.
Parameters
- capability: string
Returns void
- Defined in service.ts:96

addCapability

addCapability(capability: string): void
Sets the capability once; Duplicate when set, EmptyValue when empty.
Parameters
- capability: string
Returns void
- Defined in service.ts:101

hasKeyReference

hasKeyReference(reference: Reference): boolean
Whether the service references this key.
Parameters
- reference: Reference
Returns boolean
- Defined in service.ts:113

addKeyReference

addKeyReference(keyReference: Reference): void
Adds a key reference; Duplicate when it is already there.
Parameters
- keyReference: Reference
Returns void
- Defined in service.ts:118

removeKeyReference

removeKeyReference(reference: Reference): boolean
Removes a key reference; whether it was there.
Parameters
- reference: Reference
Returns boolean
- Defined in service.ts:125

addKey

addKey(key: { publicKeys: PublicKeys }): void
References the key's public keys.
Parameters
- key: { publicKeys: PublicKeys }
Returns void
- Defined in service.ts:130

hasDelegateReference

hasDelegateReference(reference: Reference): boolean
Whether the service references this delegate.
Parameters
- reference: Reference
Returns boolean
- Defined in service.ts:140

addDelegateReference

addDelegateReference(delegateReference: Reference): void
Adds a delegate reference; Duplicate when it is already there.
Parameters
- delegateReference: Reference
Returns void
- Defined in service.ts:145

removeDelegateReference

removeDelegateReference(reference: Reference): boolean
Removes a delegate reference; whether it was there.
Parameters
- reference: Reference
Returns boolean
- Defined in service.ts:152

addDelegate

addDelegate(delegate: { xid: XID }): void
References the delegate's (or document's) XID.
Parameters
- delegate: { xid: XID }
Returns void
- Defined in service.ts:157

setName

setName(name: string): void
Sets the name once; Duplicate when set, EmptyValue when empty.
Parameters
- name: string
Returns void
- Defined in service.ts:167

addAllow

addAllow(privilege: Privilege): void
Allows privilege.
Parameters
- privilege: Privilege
Returns void
Implementation of HasPermissions.addAllow
- Defined in service.ts:189

addDeny

addDeny(privilege: Privilege): void
Denies privilege. Written to the wire, but not read back: see the class.
Parameters
- privilege: Privilege
Returns void
Implementation of HasPermissions.addDeny
- Defined in service.ts:194

removeAllow

removeAllow(privilege: Privilege): void
Stops allowing privilege.
Parameters
- privilege: Privilege
Returns void
Implementation of HasPermissions.removeAllow
- Defined in service.ts:199

removeDeny

removeDeny(privilege: Privilege): void
Stops denying privilege.
Parameters
- privilege: Privilege
Returns void
Implementation of HasPermissions.removeDeny
- Defined in service.ts:204

clearAllPermissions

clearAllPermissions(): void
Empties both sets.

Returns void
Implementation of HasPermissions.clearAllPermissions
- Defined in service.ts:209

toEnvelope

toEnvelope(): Envelope
The URI as the subject; 'key', 'delegate', 'capability', 'name' and the permissions.

Returns Envelope
- Defined in service.ts:214

`Static`fromEnvelope

fromEnvelope(envelope: Envelope): Service
A service from its envelope. Rejects nested assertions (UnexpectedNestedAssertions) and any predicate but 'key', 'delegate', 'capability', 'name' and 'allow' (UnexpectedPredicate; a predicate that is not a known value is EnvelopeParsing); a subject or object of the wrong type is Cbor.
Parameters
- envelope: Envelope
Returns Service
- Defined in service.ts:234

equals

equals(other: Service): boolean
Same URI, references, permissions, capability and name — as the reference's equality.
Parameters
- other: Service
Returns boolean
- Defined in service.ts:266

clone

clone(): Service
A copy.

Returns Service
- Defined in service.ts:279