> Documentation index: https://www.gooddata.ai/docs/gooddata-ui/llms.txt lists every page of these docs as Markdown.

# IShareDialogProps

- Package: [@gooddata/sdk-ui-dashboard](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/index.md)
- Kind: interface
- Stability: alpha
- Source: https://github.com/gooddata/gooddata-ui-sdk/blob/rel/11.64/libs/sdk-ui-dashboard/src/presentation/shareDialog/types.ts

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

**Signature:**

```typescript
export interface IShareDialogProps 
```

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [applyShareGrantOnSelect](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.isharedialogprops/index.md#isharedialogpropsapplysharegrantonselect) |  | boolean | **_(ALPHA)_** Apply share grant on select, without confirming? |
| [backend](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.isharedialogprops/index.md#isharedialogpropsbackend) |  | [IAnalyticalBackend](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.ianalyticalbackend/index.md) | **_(ALPHA)_** Analytical backend from which the dashboard obtains data to render. |
| [currentUser](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.isharedialogprops/index.md#isharedialogpropscurrentuser) |  | [IUser](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iuser/index.md) | **_(ALPHA)_** Current user |
| [currentUserPermissions](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.isharedialogprops/index.md#isharedialogpropscurrentuserpermissions) |  | CurrentUserPermissions | **_(ALPHA)_** Dashboard permissions for current user. |
| [dashboardFilters](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.isharedialogprops/index.md#isharedialogpropsdashboardfilters) |  | [FilterContextItem](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.filtercontextitem/index.md)[] | **_(ALPHA)_** Dashboard filters |
| [dashboardParameters?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.isharedialogprops/index.md#isharedialogpropsdashboardparameters) |  | [IDashboardParameter](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboardparameter/index.md)[] | **_(ALPHA)_** _(Optional)_ Dashboard parameters |
| [isCurrentUserWorkspaceManager](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.isharedialogprops/index.md#isharedialogpropsiscurrentuserworkspacemanager) |  | boolean | **_(ALPHA)_** Is currently logger user a workspace manager? |
| [isGranteeShareLoading](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.isharedialogprops/index.md#isharedialogpropsisgranteeshareloading) |  | boolean | **_(ALPHA)_** Is grantee share loading? |
| [isLockingSupported](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.isharedialogprops/index.md#isharedialogpropsislockingsupported) |  | boolean | **_(ALPHA)_** Is locking of the dashboard supported by the currently logged user and backend? |
| [isShareGrantHidden](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.isharedialogprops/index.md#isharedialogpropsissharegranthidden) |  | boolean | **_(ALPHA)_** Is share grant hidden? |
| [isVisible?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.isharedialogprops/index.md#isharedialogpropsisvisible) |  | boolean | **_(ALPHA)_** _(Optional)_ Is share dialog visible? |
| [onApply](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.isharedialogprops/index.md#isharedialogpropsonapply) |  | (payload: [ISharingApplyPayload](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.isharingapplypayload/index.md), closeOnApply?: boolean) => void | **_(ALPHA)_** Callback to be called when user apply share dialog |
| [onCancel](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.isharedialogprops/index.md#isharedialogpropsoncancel) |  | () => void | **_(ALPHA)_** Callback to be called when user closes the share dialog. |
| [onError?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.isharedialogprops/index.md#isharedialogpropsonerror) |  | (error: [GoodDataSdkError](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.gooddatasdkerror/index.md)) => void | **_(ALPHA)_** _(Optional)_ Callback to be called, when error occurs. |
| [onInteraction?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.isharedialogprops/index.md#isharedialogpropsoninteraction) |  | (data: IShareDialogInteractionData) => void | **_(ALPHA)_** _(Optional)_ Callback to be called on specific share dialog interactions. |
| [onShareLinkCopy](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.isharedialogprops/index.md#isharedialogpropsonsharelinkcopy) |  | (shareLink: string) => void | **_(ALPHA)_** Callback to be called when user copies share link |
| [sharedObject](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.isharedialogprops/index.md#isharedialogpropssharedobject) |  | ISharedObject | **_(ALPHA)_** Object to share |
| [showDashboardShareLink](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.isharedialogprops/index.md#isharedialogpropsshowdashboardsharelink) |  | boolean | **_(ALPHA)_** Show dashboard share link? |
| [workspace](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.isharedialogprops/index.md#isharedialogpropsworkspace) |  | string | **_(ALPHA)_** Identifier of analytical workspace, from which the dashboard obtains data to render. |

## Property details

### IShareDialogProps.applyShareGrantOnSelect

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Apply share grant on select, without confirming?

**Signature:**

```typescript
applyShareGrantOnSelect: boolean;
```

### IShareDialogProps.backend

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Analytical backend from which the dashboard obtains data to render.

**Signature:**

```typescript
backend: IAnalyticalBackend;
```

### IShareDialogProps.currentUser

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Current user

**Signature:**

```typescript
currentUser: IUser;
```

### IShareDialogProps.currentUserPermissions

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Dashboard permissions for current user.

**Signature:**

```typescript
currentUserPermissions: CurrentUserPermissions;
```

### IShareDialogProps.dashboardFilters

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Dashboard filters

**Signature:**

```typescript
dashboardFilters: FilterContextItem[];
```

### IShareDialogProps.dashboardParameters

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Dashboard parameters

**Signature:**

```typescript
dashboardParameters?: IDashboardParameter[];
```

### IShareDialogProps.isCurrentUserWorkspaceManager

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Is currently logger user a workspace manager?

**Signature:**

```typescript
isCurrentUserWorkspaceManager: boolean;
```

### IShareDialogProps.isGranteeShareLoading

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Is grantee share loading?

**Signature:**

```typescript
isGranteeShareLoading: boolean;
```

### IShareDialogProps.isLockingSupported

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Is locking of the dashboard supported by the currently logged user and backend?

**Signature:**

```typescript
isLockingSupported: boolean;
```

### IShareDialogProps.isShareGrantHidden

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Is share grant hidden?

**Signature:**

```typescript
isShareGrantHidden: boolean;
```

### IShareDialogProps.isVisible

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Is share dialog visible?

**Signature:**

```typescript
isVisible?: boolean;
```

### IShareDialogProps.onApply

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Callback to be called when user apply share dialog

**Signature:**

```typescript
onApply: (payload: ISharingApplyPayload, closeOnApply?: boolean) => void;
```

### IShareDialogProps.onCancel

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Callback to be called when user closes the share dialog.

**Signature:**

```typescript
onCancel: () => void;
```

### IShareDialogProps.onError

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Callback to be called, when error occurs.

**Signature:**

```typescript
onError?: (error: GoodDataSdkError) => void;
```

### IShareDialogProps.onInteraction

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Callback to be called on specific share dialog interactions.

**Signature:**

```typescript
onInteraction?: (data: IShareDialogInteractionData) => void;
```

### IShareDialogProps.onShareLinkCopy

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Callback to be called when user copies share link

**Signature:**

```typescript
onShareLinkCopy: (shareLink: string) => void;
```

### IShareDialogProps.sharedObject

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Object to share

**Signature:**

```typescript
sharedObject: ISharedObject;
```

### IShareDialogProps.showDashboardShareLink

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Show dashboard share link?

**Signature:**

```typescript
showDashboardShareLink: boolean;
```

### IShareDialogProps.workspace

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Identifier of analytical workspace, from which the dashboard obtains data to render.

**Signature:**

```typescript
workspace: string;
```