IShareDialogProps
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
export interface IShareDialogProps
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
boolean | (ALPHA) Apply share grant on select, without confirming? | ||
(ALPHA) Analytical backend from which the dashboard obtains data to render. | |||
(ALPHA) Current user | |||
CurrentUserPermissions | (ALPHA) Dashboard permissions for current user. | ||
(ALPHA) Dashboard filters | |||
(ALPHA) (Optional) Dashboard parameters | |||
boolean | (ALPHA) Is currently logger user a workspace manager? | ||
boolean | (ALPHA) Is grantee share loading? | ||
boolean | (ALPHA) Is locking of the dashboard supported by the currently logged user and backend? | ||
boolean | (ALPHA) Is share grant hidden? | ||
boolean | (ALPHA) (Optional) Is share dialog visible? | ||
(payload: ISharingApplyPayload, closeOnApply?: boolean) => void | (ALPHA) Callback to be called when user apply share dialog | ||
() => void | (ALPHA) Callback to be called when user closes the share dialog. | ||
(error: GoodDataSdkError) => void | (ALPHA) (Optional) Callback to be called, when error occurs. | ||
(data: IShareDialogInteractionData) => void | (ALPHA) (Optional) Callback to be called on specific share dialog interactions. | ||
(shareLink: string) => void | (ALPHA) Callback to be called when user copies share link | ||
ISharedObject | (ALPHA) Object to share | ||
boolean | (ALPHA) Show dashboard share link? | ||
string | (ALPHA) Identifier of analytical workspace, from which the dashboard obtains data to render. |
Property details
IShareDialogProps.applyShareGrantOnSelectpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Apply share grant on select, without confirming?
applyShareGrantOnSelect: boolean;
IShareDialogProps.backendpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Analytical backend from which the dashboard obtains data to render.
backend: IAnalyticalBackend;
IShareDialogProps.currentUserpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Current user
currentUser: IUser;
IShareDialogProps.currentUserPermissionspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Dashboard permissions for current user.
currentUserPermissions: CurrentUserPermissions;
IShareDialogProps.dashboardFilterspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Dashboard filters
dashboardFilters: FilterContextItem[];
IShareDialogProps.dashboardParameterspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Dashboard parameters
dashboardParameters?: IDashboardParameter[];
IShareDialogProps.isCurrentUserWorkspaceManagerpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Is currently logger user a workspace manager?
isCurrentUserWorkspaceManager: boolean;
IShareDialogProps.isGranteeShareLoadingpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Is grantee share loading?
isGranteeShareLoading: boolean;
IShareDialogProps.isLockingSupportedpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Is locking of the dashboard supported by the currently logged user and backend?
isLockingSupported: boolean;
IShareDialogProps.isShareGrantHiddenpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Is share grant hidden?
isShareGrantHidden: boolean;
IShareDialogProps.isVisiblepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Is share dialog visible?
isVisible?: boolean;
IShareDialogProps.onApplypropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Callback to be called when user apply share dialog
onApply: (payload: ISharingApplyPayload, closeOnApply?: boolean) => void;
IShareDialogProps.onCancelpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Callback to be called when user closes the share dialog.
onCancel: () => void;
IShareDialogProps.onErrorpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Callback to be called, when error occurs.
onError?: (error: GoodDataSdkError) => void;
IShareDialogProps.onInteractionpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Callback to be called on specific share dialog interactions.
onInteraction?: (data: IShareDialogInteractionData) => void;
IShareDialogProps.onShareLinkCopypropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Callback to be called when user copies share link
onShareLinkCopy: (shareLink: string) => void;
IShareDialogProps.sharedObjectpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Object to share
sharedObject: ISharedObject;
IShareDialogProps.showDashboardShareLinkpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Show dashboard share link?
showDashboardShareLink: boolean;
IShareDialogProps.workspacepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Identifier of analytical workspace, from which the dashboard obtains data to render.
workspace: string;