# CustomPermissionGroup

Represents a group of custom permissions for a Security Token

## Hierarchy

↳ [PermissionGroup](https://developers.polymath.network/polymesh-sdk-api-reference/v12.0.2/classes/permissiongroup)

↳ **CustomPermissionGroup**

## Index

### Properties

* [context](#protected-context)
* [id](#id)
* [ticker](#ticker)
* [uuid](#uuid)

### Methods

* [exists](#exists)
* [getPermissions](#getpermissions)
* [isEqual](#isequal)
* [setPermissions](#setpermissions)
* [toJson](#tojson)
* [generateUuid](#static-generateuuid)
* [unserialize](#static-unserialize)

## Properties

### `Protected` context

• **context**: [*Context*](https://developers.polymath.network/polymesh-sdk-api-reference/v12.0.2/classes/context)

*Inherited from* [*Entity*](https://developers.polymath.network/polymesh-sdk-api-reference/v12.0.2/classes/entity)*.*[*context*](https://developers.polymath.network/polymesh-sdk-api-reference/v12.0.2/entity#protected-context)

*Defined in* [*src/api/entities/Entity.ts:48*](https://github.com/PolymathNetwork/polymesh-sdk/blob/44d12f59/src/api/entities/Entity.ts#L48)

***

### id

• **id**: *BigNumber*

*Defined in* [*src/api/entities/CustomPermissionGroup.ts:45*](https://github.com/PolymathNetwork/polymesh-sdk/blob/44d12f59/src/api/entities/CustomPermissionGroup.ts#L45)

***

### ticker

• **ticker**: *string*

*Inherited from* [*PermissionGroup*](https://developers.polymath.network/polymesh-sdk-api-reference/v12.0.2/classes/permissiongroup)*.*[*ticker*](https://developers.polymath.network/polymesh-sdk-api-reference/v12.0.2/permissiongroup#ticker)

*Defined in* [*src/api/entities/PermissionGroup.ts:27*](https://github.com/PolymathNetwork/polymesh-sdk/blob/44d12f59/src/api/entities/PermissionGroup.ts#L27)

***

### uuid

• **uuid**: *string*

*Inherited from* [*Entity*](https://developers.polymath.network/polymesh-sdk-api-reference/v12.0.2/classes/entity)*.*[*uuid*](https://developers.polymath.network/polymesh-sdk-api-reference/v12.0.2/entity#uuid)

*Defined in* [*src/api/entities/Entity.ts:46*](https://github.com/PolymathNetwork/polymesh-sdk/blob/44d12f59/src/api/entities/Entity.ts#L46)

## Methods

### exists

▸ **exists**(): *Promise‹boolean›*

*Overrides* [*Entity*](https://developers.polymath.network/polymesh-sdk-api-reference/v12.0.2/classes/entity)*.*[*exists*](https://developers.polymath.network/polymesh-sdk-api-reference/v12.0.2/entity#abstract-exists)

*Defined in* [*src/api/entities/CustomPermissionGroup.ts:117*](https://github.com/PolymathNetwork/polymesh-sdk/blob/44d12f59/src/api/entities/CustomPermissionGroup.ts#L117)

Determine whether this Custom Permission Group exists on chain

**Returns:** *Promise‹boolean›*

***

### getPermissions

▸ **getPermissions**(): *Promise‹*[*GroupPermissions*](https://developers.polymath.network/polymesh-sdk-api-reference/v12.0.2/globals#grouppermissions)*›*

*Overrides* [*PermissionGroup*](https://developers.polymath.network/polymesh-sdk-api-reference/v12.0.2/classes/permissiongroup)*.*[*getPermissions*](https://developers.polymath.network/polymesh-sdk-api-reference/v12.0.2/permissiongroup#abstract-getpermissions)

*Defined in* [*src/api/entities/CustomPermissionGroup.ts:87*](https://github.com/PolymathNetwork/polymesh-sdk/blob/44d12f59/src/api/entities/CustomPermissionGroup.ts#L87)

Retrieve the list of permissions and transaction groups associated with this Permission Group

**Returns:** *Promise‹*[*GroupPermissions*](https://developers.polymath.network/polymesh-sdk-api-reference/v12.0.2/globals#grouppermissions)*›*

***

### isEqual

▸ **isEqual**(`entity`: [Entity](https://developers.polymath.network/polymesh-sdk-api-reference/v12.0.2/classes/entity)‹unknown, unknown›): *boolean*

*Inherited from* [*Entity*](https://developers.polymath.network/polymesh-sdk-api-reference/v12.0.2/classes/entity)*.*[*isEqual*](https://developers.polymath.network/polymesh-sdk-api-reference/v12.0.2/entity#isequal)

*Defined in* [*src/api/entities/Entity.ts:61*](https://github.com/PolymathNetwork/polymesh-sdk/blob/44d12f59/src/api/entities/Entity.ts#L61)

Determine whether this Entity is the same as another one

**Parameters:**

| Name     | Type                                                                                                              |
| -------- | ----------------------------------------------------------------------------------------------------------------- |
| `entity` | [Entity](https://developers.polymath.network/polymesh-sdk-api-reference/v12.0.2/classes/entity)‹unknown, unknown› |

**Returns:** *boolean*

***

### setPermissions

▸ **setPermissions**(`args`: [SetGroupPermissionsParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v12/docs/interfaces/setgrouppermissionsparams.md), `opts?`: [ProcedureOpts](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v12/docs/interfaces/procedureopts.md)): *Promise‹*[*TransactionQueue*](https://developers.polymath.network/polymesh-sdk-api-reference/v12.0.2/classes/transactionqueue)*‹void››*

*Defined in* [*src/api/entities/CustomPermissionGroup.ts:80*](https://github.com/PolymathNetwork/polymesh-sdk/blob/44d12f59/src/api/entities/CustomPermissionGroup.ts#L80)

Modify the group's permissions

**`note`** this method is of type [ProcedureMethod](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v12/docs/interfaces/proceduremethod.md), which means you can call `setPermissions.checkAuthorization` on it to see whether the Current Account has the required permissions to run it

**Parameters:**

| Name    | Type                                                                                                                                    |
| ------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| `args`  | [SetGroupPermissionsParams](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v12/docs/interfaces/setgrouppermissionsparams.md) |
| `opts?` | [ProcedureOpts](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v12/docs/interfaces/procedureopts.md)                         |

**Returns:** *Promise‹*[*TransactionQueue*](https://developers.polymath.network/polymesh-sdk-api-reference/v12.0.2/classes/transactionqueue)*‹void››*

***

### toJson

▸ **toJson**(): *HumanReadable*

*Overrides* [*Entity*](https://developers.polymath.network/polymesh-sdk-api-reference/v12.0.2/classes/entity)*.*[*toJson*](https://developers.polymath.network/polymesh-sdk-api-reference/v12.0.2/entity#abstract-tojson)

*Defined in* [*src/api/entities/CustomPermissionGroup.ts:66*](https://github.com/PolymathNetwork/polymesh-sdk/blob/44d12f59/src/api/entities/CustomPermissionGroup.ts#L66)

Return the Group's ID

**Returns:** *HumanReadable*

***

### `Static` generateUuid

▸ **generateUuid**‹**Identifiers**›(`identifiers`: Identifiers): *string*

*Inherited from* [*Entity*](https://developers.polymath.network/polymesh-sdk-api-reference/v12.0.2/classes/entity)*.*[*generateUuid*](https://developers.polymath.network/polymesh-sdk-api-reference/v12.0.2/entity#static-generateuuid)

*Defined in* [*src/api/entities/Entity.ts:14*](https://github.com/PolymathNetwork/polymesh-sdk/blob/44d12f59/src/api/entities/Entity.ts#L14)

Generate the Entity's UUID from its identifying properties

**Type parameters:**

▪ **Identifiers**

**Parameters:**

| Name          | Type        | Description |
| ------------- | ----------- | ----------- |
| `identifiers` | Identifiers |             |

**Returns:** *string*

***

### `Static` unserialize

▸ **unserialize**‹**Identifiers**›(`serialized`: string): *Identifiers*

*Inherited from* [*Entity*](https://developers.polymath.network/polymesh-sdk-api-reference/v12.0.2/classes/entity)*.*[*unserialize*](https://developers.polymath.network/polymesh-sdk-api-reference/v12.0.2/entity#static-unserialize)

*Defined in* [*src/api/entities/Entity.ts:23*](https://github.com/PolymathNetwork/polymesh-sdk/blob/44d12f59/src/api/entities/Entity.ts#L23)

Unserialize a UUID into its Unique Identifiers

**Type parameters:**

▪ **Identifiers**

**Parameters:**

| Name         | Type   | Description         |
| ------------ | ------ | ------------------- |
| `serialized` | string | UUID to unserialize |

**Returns:** *Identifiers*