Class CollectionPermissionsWithDetails<T>

Type Parameters

T extends NumberType

Hierarchy (view full)

CollectionPermissions<T>
- CollectionPermissionsWithDetails

Implements

Constructors

constructor

new CollectionPermissionsWithDetails<T>(data): CollectionPermissionsWithDetails<T>
Type Parameters
- T extends NumberType
Parameters
- data: iCollectionPermissionsWithDetails<T>
Returns CollectionPermissionsWithDetails<T>
Overrides CollectionPermissions.constructor
- Defined in src/core/permissions.ts:1155

Properties

canArchiveCollection

canArchiveCollection: TimedUpdatePermission<T>[]

The permissions for archiving the collection.

canDeleteCollection

canDeleteCollection: ActionPermission<T>[]

The permissions for deleting the collection.

canUpdateBadgeMetadata

canUpdateBadgeMetadata: TimedUpdateWithBadgeIdsPermission<T>[]

The permissions for updating the badge metadata.

canUpdateCollectionApprovals

canUpdateCollectionApprovals: CollectionApprovalPermissionWithDetails<T>[]

The permissions for updating the collection approved transfers.

canUpdateCollectionMetadata

canUpdateCollectionMetadata: TimedUpdatePermission<T>[]

The permissions for updating the collection metadata.

canUpdateCustomData

canUpdateCustomData: TimedUpdatePermission<T>[]

The permissions for updating the custom data.

canUpdateManager

canUpdateManager: TimedUpdatePermission<T>[]

The permissions for updating the manager.

canUpdateOffChainBalancesMetadata

canUpdateOffChainBalancesMetadata: TimedUpdatePermission<T>[]

The permissions for updating the off-chain balances metadata.

canUpdateStandards

canUpdateStandards: TimedUpdatePermission<T>[]

The permissions for updating the standards.

canUpdateValidBadgeIds

canUpdateValidBadgeIds: BadgeIdsActionPermission<T>[]

The permissions for creating more badges.

Methods

clone

clone(): CollectionPermissionsWithDetails
Deep copies the object and returns a new instance.
Type Parameters
- U extends NumberType
Returns CollectionPermissionsWithDetails
Implementation of CustomType.clone
Overrides CollectionPermissions.clone
- Defined in src/core/permissions.ts:1166

convert

convert(convertFunction): CollectionPermissionsWithDetails
Converts the object to a different NumberType equivalent.
Type Parameters
- U extends NumberType
Parameters
- convertFunction: ((item: NumberType) => U)
 - - (item): U
 - Parameters
 item: NumberType
 Returns U
Returns CollectionPermissionsWithDetails
Implementation of CustomType.convert
Overrides CollectionPermissions.convert
- Defined in src/core/permissions.ts:1162

equals

equals(other, normalizeNumberTypes?): boolean
Compares this object's fields to another object's fields for equality. Equality is determined by comparing the JSON representations of the objects.

If normalizeNumberTypes is true, then all number types will be compared as strings (i.e. "1n" === "1" === 1). Else, they will be compared as their native types (i.e. 1n !== 1 !== "1").
Type Parameters
- U extends CustomType
Parameters
- other: undefined | null | CustomType
- OptionalnormalizeNumberTypes: boolean
Returns boolean
Implementation of CustomType.equals
Inherited from CollectionPermissions.equals
- Defined in src/common/base.ts:96

getNumberFieldNames

getNumberFieldNames(): string[]
Internal helper method to convert the number fields of the object to a different NumberType equivalent.

Returns string[]
Implementation of CustomType.getNumberFieldNames
Inherited from CollectionPermissions.getNumberFieldNames
- Defined in src/common/base.ts:106

toJson

toJson(): JsonObject
Converts the object to a JSON object with all primitive types.

Returns JsonObject
Implementation of CustomType.toJson
Inherited from CollectionPermissions.toJson
- Defined in src/common/base.ts:88

toJsonString

toJsonString(): string
Converts the object to a JSON string.

Returns string
Implementation of CustomType.toJsonString
Inherited from CollectionPermissions.toJsonString
- Defined in src/common/base.ts:92

toProto

toProto(): proto.badges.CollectionPermissions
Returns proto.badges.CollectionPermissions
Inherited from CollectionPermissions.toProto
- Defined in src/core/permissions.ts:408

`Static`InitEmpty

InitEmpty(): CollectionPermissions<bigint>
Returns CollectionPermissions<bigint>
Inherited from CollectionPermissions.InitEmpty
- Defined in src/core/permissions.ts:463

`Static`fromJson

fromJson(jsonValue, convertFunction, options?): CollectionPermissions
Type Parameters
- U extends NumberType
Parameters
- jsonValue: JsonValue
- convertFunction: ((item: NumberType) => U)
 - - (item): U
 - Parameters
 item: NumberType
 Returns U
- Optionaloptions: Partial<JsonReadOptions>
Returns CollectionPermissions
Inherited from CollectionPermissions.fromJson
- Defined in src/core/permissions.ts:412

`Static`fromJsonString

fromJsonString(jsonString, convertFunction, options?): CollectionPermissions
Type Parameters
- U extends NumberType
Parameters
- jsonString: string
- convertFunction: ((item: NumberType) => U)
 - - (item): U
 - Parameters
 item: NumberType
 Returns U
- Optionaloptions: Partial<JsonReadOptions>
Returns CollectionPermissions
Inherited from CollectionPermissions.fromJsonString
- Defined in src/core/permissions.ts:420

`Static`fromProto

fromProto(protoMsg, convertFunction): CollectionPermissions
Type Parameters
- U extends NumberType
Parameters
- protoMsg: proto.badges.CollectionPermissions
- convertFunction: ((item: NumberType) => U)
 - - (item): U
 - Parameters
 item: NumberType
 Returns U
Returns CollectionPermissions
Inherited from CollectionPermissions.fromProto
- Defined in src/core/permissions.ts:428

`Static`validateUpdate

validateUpdate(oldPermissions, newPermissions): null | Error
Type Parameters
- U extends NumberType
Parameters
- oldPermissions: CollectionPermissionsWithDetails
- newPermissions: CollectionPermissionsWithDetails
Returns null | Error
Overrides CollectionPermissions.validateUpdate
- Defined in src/core/permissions.ts:1170

Class CollectionPermissionsWithDetails<T>

Type Parameters

Hierarchy (view full)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns CollectionPermissionsWithDetails<T>

Properties

canArchiveCollection

canDeleteCollection

canUpdateBadgeMetadata

canUpdateCollectionApprovals

canUpdateCollectionMetadata

canUpdateCustomData

canUpdateManager

canUpdateOffChainBalancesMetadata

canUpdateStandards

canUpdateValidBadgeIds

Methods

clone

Type Parameters

Returns CollectionPermissionsWithDetails<U>

convert

Type Parameters

Parameters

Parameters

Returns U

Returns CollectionPermissionsWithDetails<U>

equals

Type Parameters

Parameters

Returns boolean

getNumberFieldNames

Returns string[]

toJson

Returns JsonObject

toJsonString

Returns string

toProto

Returns proto.badges.CollectionPermissions

StaticInitEmpty

Returns CollectionPermissions<bigint>

StaticfromJson

Type Parameters

Parameters

Parameters

Returns U

Returns CollectionPermissions<U>

StaticfromJsonString

Type Parameters

Parameters

Parameters

Returns U

Returns CollectionPermissions<U>

StaticfromProto

Type Parameters

Parameters

Parameters

Returns U

Returns CollectionPermissions<U>

StaticvalidateUpdate

Type Parameters

Parameters

Returns null | Error

Settings

On This Page

`Static`InitEmpty

`Static`fromJson

`Static`fromJsonString

`Static`fromProto

`Static`validateUpdate