Class: CollectionPermissions<T>

Defined in: packages/bitbadgesjs-sdk/src/core/permissions.ts:397

CollectionPermissions represents the permissions of a collection.

Extends#

• BaseNumberTypeClass<CollectionPermissions<T>>

Extended by#

• CollectionPermissionsWithDetails

Type Parameters#

T#

T extends NumberType

Implements#

• iCollectionPermissions<T>

Constructors#

Constructor#

new CollectionPermissions<T>(msg): CollectionPermissions<T>

Defined in: packages/bitbadgesjs-sdk/src/core/permissions.ts:410

Parameters#

msg#

iCollectionPermissions<T>

Returns#

CollectionPermissions<T>

Overrides#

BaseNumberTypeClass.constructor

Properties#

canAddMoreAliasPaths#

canAddMoreAliasPaths: ActionPermission<T>[]

Defined in: packages/bitbadgesjs-sdk/src/core/permissions.ts:407

The permissions for adding more alias paths to the collection.

Implementation of#

iCollectionPermissions.canAddMoreAliasPaths

---

canAddMoreCosmosCoinWrapperPaths#

canAddMoreCosmosCoinWrapperPaths: ActionPermission<T>[]

Defined in: packages/bitbadgesjs-sdk/src/core/permissions.ts:408

The permissions for adding more cosmos coin wrapper paths to the collection.

Implementation of#

iCollectionPermissions.canAddMoreCosmosCoinWrapperPaths

---

canArchiveCollection#

canArchiveCollection: ActionPermission<T>[]

Defined in: packages/bitbadgesjs-sdk/src/core/permissions.ts:399

The permissions for archiving the collection.

Implementation of#

iCollectionPermissions.canArchiveCollection

---

canDeleteCollection#

canDeleteCollection: ActionPermission<T>[]

Defined in: packages/bitbadgesjs-sdk/src/core/permissions.ts:398

The permissions for deleting the collection.

Implementation of#

iCollectionPermissions.canDeleteCollection

---

canUpdateCollectionApprovals#

canUpdateCollectionApprovals: CollectionApprovalPermission<T>[]

Defined in: packages/bitbadgesjs-sdk/src/core/permissions.ts:406

The permissions for updating the collection approved transfers.

Implementation of#

iCollectionPermissions.canUpdateCollectionApprovals

---

canUpdateCollectionMetadata#

canUpdateCollectionMetadata: ActionPermission<T>[]

Defined in: packages/bitbadgesjs-sdk/src/core/permissions.ts:403

The permissions for updating the collection metadata.

Implementation of#

iCollectionPermissions.canUpdateCollectionMetadata

---

canUpdateCustomData#

canUpdateCustomData: ActionPermission<T>[]

Defined in: packages/bitbadgesjs-sdk/src/core/permissions.ts:401

The permissions for updating the custom data.

Implementation of#

iCollectionPermissions.canUpdateCustomData

---

canUpdateManager#

canUpdateManager: ActionPermission<T>[]

Defined in: packages/bitbadgesjs-sdk/src/core/permissions.ts:402

The permissions for updating the manager.

Implementation of#

iCollectionPermissions.canUpdateManager

---

canUpdateStandards#

canUpdateStandards: ActionPermission<T>[]

Defined in: packages/bitbadgesjs-sdk/src/core/permissions.ts:400

The permissions for updating the standards.

Implementation of#

iCollectionPermissions.canUpdateStandards

---

canUpdateTokenMetadata#

canUpdateTokenMetadata: TokenIdsActionPermission<T>[]

Defined in: packages/bitbadgesjs-sdk/src/core/permissions.ts:405

The permissions for updating the token metadata.

Implementation of#

iCollectionPermissions.canUpdateTokenMetadata

---

canUpdateValidTokenIds#

canUpdateValidTokenIds: TokenIdsActionPermission<T>[]

Defined in: packages/bitbadgesjs-sdk/src/core/permissions.ts:404

The permissions for creating more tokens.

Implementation of#

iCollectionPermissions.canUpdateValidTokenIds

Methods#

clone()#

clone(): CollectionPermissions

Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:151

Deep copies the object and returns a new instance.

Returns#

CollectionPermissions

Inherited from#

BaseNumberTypeClass.clone

---

convert()#

convert<U>(convertFunction, options?): CollectionPermissions<U>

Defined in: packages/bitbadgesjs-sdk/src/core/permissions.ts:439

Converts the object to a different NumberType equivalent.

Type Parameters#

U#

U extends NumberType

Parameters#

convertFunction#

(item) => U

options?#

ConvertOptions

Returns#

CollectionPermissions<U>

Overrides#

BaseNumberTypeClass.convert

---

equals()#

equals<U>(other, normalizeNumberTypes?): boolean

Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:147

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#

U extends CustomType<U>

Parameters#

other#

CustomType<U> | null | undefined

normalizeNumberTypes?#

boolean

Returns#

boolean

Inherited from#

BaseNumberTypeClass.equals

---

getNumberFieldNames()#

getNumberFieldNames(): string[]

Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:157

Internal helper method to convert the number fields of the object to a different NumberType equivalent.

Returns#

string[]

Inherited from#

BaseNumberTypeClass.getNumberFieldNames

---

hasNumberFields()#

hasNumberFields(): boolean

Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:161

Checks if the object has number fields.

Returns#

boolean

Inherited from#

BaseNumberTypeClass.hasNumberFields

---

toBech32Addresses()#

toBech32Addresses(prefix): CollectionPermissions<T>

Defined in: packages/bitbadgesjs-sdk/src/core/permissions.ts:533

Parameters#

prefix#

string

Returns#

CollectionPermissions<T>

---

toJson()#

toJson(): JsonObject

Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:139

Converts the object to a JSON object with all primitive types.

Returns#

JsonObject

Inherited from#

BaseNumberTypeClass.toJson

---

toJsonString()#

toJsonString(): string

Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:143

Converts the object to a JSON string.

Returns#

string

Inherited from#

BaseNumberTypeClass.toJsonString

---

toProto()#

toProto(): CollectionPermissions

Defined in: packages/bitbadgesjs-sdk/src/core/permissions.ts:457

Returns#

CollectionPermissions

---

fromJson()#

static fromJson<U>(jsonValue, convertFunction, options?): CollectionPermissions<U>

Defined in: packages/bitbadgesjs-sdk/src/core/permissions.ts:461

Type Parameters#

U#

U extends NumberType

Parameters#

jsonValue#

JsonValue

convertFunction#

(item) => U

options?#

Partial<JsonReadOptions>

Returns#

CollectionPermissions<U>

---

fromJsonString()#

static fromJsonString<U>(jsonString, convertFunction, options?): CollectionPermissions<U>

Defined in: packages/bitbadgesjs-sdk/src/core/permissions.ts:469

Type Parameters#

U#

U extends NumberType

Parameters#

jsonString#

string

convertFunction#

(item) => U

options?#

Partial<JsonReadOptions>

Returns#

CollectionPermissions<U>

---

fromProto()#

static fromProto<U>(protoMsg, convertFunction): CollectionPermissions<U>

Defined in: packages/bitbadgesjs-sdk/src/core/permissions.ts:477

Type Parameters#

U#

U extends NumberType

Parameters#

protoMsg#

CollectionPermissions

convertFunction#

(item) => U

Returns#

CollectionPermissions<U>

---

InitEmpty()#

static InitEmpty(): CollectionPermissions<bigint>

Defined in: packages/bitbadgesjs-sdk/src/core/permissions.ts:517

Returns#

CollectionPermissions<bigint>

---

validateUpdate()#

static validateUpdate<U>(oldPermissions, newPermissions): Error | null

Defined in: packages/bitbadgesjs-sdk/src/core/permissions.ts:496

Type Parameters#

U#

U extends NumberType

Parameters#

oldPermissions#

CollectionPermissionsWithDetails<U>

newPermissions#

CollectionPermissionsWithDetails<U>

Returns#

Error | null