ItemSharingDialogConfig interface

Package:

@ms-fabric/workload-client

An interface representing the input configuration to open link sharing dialog or direct sharing dialog

Properties

customizedTitle	Sharing dialog title that can be customized by each API call
defaultShareOptions	Share options that are checked by default
itemObjectId	The object id of the item
itemType	The type of the item
linkSharing	If current action is to open link sharing dialog or direct sharing dialog
preSelectedUserObjectIDs	A list of user object ids to grant access by default. - Optional. Only supported in direct sharing dialog The users will be shown in email list of direct sharing dialog as pre-selected users. The users can be un-selected in following actions after opening direct sharing dialog
preSelectedUserPrincipals	A list of user principal names to grant access by default. - Optional. Only supported in direct sharing dialog The users will be shown in email list of direct sharing dialog as pre-selected users. The users can be un-selected in following actions after opening direct sharing dialog

Property Details

customizedTitle

Sharing dialog title that can be customized by each API call

customizedTitle?: string

Property Value

string

defaultShareOptions

Share options that are checked by default

defaultShareOptions?: string[]

Property Value

string[]

itemObjectId

The object id of the item

itemObjectId: string

Property Value

string

itemType

The type of the item

itemType: string

Property Value

string

linkSharing

If current action is to open link sharing dialog or direct sharing dialog

linkSharing?: boolean

Property Value

boolean

preSelectedUserObjectIDs

A list of user object ids to grant access by default. - Optional. Only supported in direct sharing dialog The users will be shown in email list of direct sharing dialog as pre-selected users. The users can be un-selected in following actions after opening direct sharing dialog

preSelectedUserObjectIDs?: string[]

Property Value

string[]

preSelectedUserPrincipals

A list of user principal names to grant access by default. - Optional. Only supported in direct sharing dialog The users will be shown in email list of direct sharing dialog as pre-selected users. The users can be un-selected in following actions after opening direct sharing dialog

preSelectedUserPrincipals?: string[]

Property Value

string[]