Class BaseLease

Package version

Describes the base lease.

Hierarchy

BaseLease
- CompleteLease

Implements

BaseLeaseInfo

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new BaseLease(info: BaseLeaseInfo): BaseLease

- Defined in baseLease.ts:35
constructor

Parameters
- info: BaseLeaseInfo
  
  The information required to create a base lease.
Returns BaseLease

Properties

isOwned

isOwned: boolean = false

property: {boolean} isOwned Indicates wether the lease is owned. true if it is owned by someone; false otherwise.

owner

owner: string

property: {string} owner The host owner for the partition.

partitionId

partitionId: string

property: {string} partitionId The associated partitionId for which the lease is held.
readonly

Methods

getInfo

getInfo(): BaseLeaseInfo

- Defined in baseLease.ts:59
Gets the lease information.

Returns BaseLeaseInfo

CompleteLeaseInfo.

isOwnedBy

isOwnedBy(possibleOwner: string): boolean

- Defined in baseLease.ts:51
Compares possibleOwner against this.owner

Parameters
- possibleOwner: string
  
  The owner name to check.
Returns boolean

boolean - true if possibleOwner is the same as this.owner, false otherwise.

Generated using TypeDoc