Interface IClipboardService
Represents an interface for managing clipboard information.
Namespace: DataWeb.Identity
Assembly: DataWeb.Core.dll
Syntax
public interface IClipboardService
Methods
AddItemsAsync(Clipboard, List<string>, string, IUser)
Adds items to the clipboard.
Declaration
Task AddItemsAsync(Clipboard clipboard, List<string> itemIdMasters, string nav, IUser user)
Parameters
Type | Name | Description |
---|---|---|
Clipboard | clipboard | The Clipboard to which items are to be added. |
List<string> | itemIdMasters | The Ids of the items to add to the clipboard. |
string | nav | The navigation information for the clipboard. |
IUser | user | The IUser who owns the clipboard. |
Returns
Type | Description |
---|---|
Task |
ClearAsync(IUser)
Clears the clipboard for the specified user.
Declaration
Task ClearAsync(IUser user)
Parameters
Type | Name | Description |
---|---|---|
IUser | user | The IUser whose clipboard is to be cleared. |
Returns
Type | Description |
---|---|
Task |
GetClipboardAsync(IUser)
Gets the clipboard information for the specified user.
Declaration
Task<Clipboard> GetClipboardAsync(IUser user)
Parameters
Type | Name | Description |
---|---|---|
IUser | user | The IUser whose clipboard information is to be retrieved. |
Returns
Type | Description |
---|---|
Task<Clipboard> | The clipboard information for the user. |
RemoveItemsAsync(Clipboard, List<string>, IUser)
Removes items from the clipboard.
Declaration
Task RemoveItemsAsync(Clipboard clipboard, List<string> itemIdMasters, IUser user)
Parameters
Type | Name | Description |
---|---|---|
Clipboard | clipboard | The clipboard from which items are to be removed. |
List<string> | itemIdMasters | The Ids of the items to remove from the clipboard. |
IUser | user | The IUser who owns the clipboard. |
Returns
Type | Description |
---|---|
Task |