Interface IKeyboardShortcutsService

Represents the Keyboard Shortcuts API service.

Namespace: Relativity.Testing.Framework.Api.Services
Assembly: Relativity.Testing.Framework.Api.dll
Syntax
public interface IKeyboardShortcutsService
Examples
_keyboardShortcutsService = relativityFacade.Resolve<IKeyboardShortcutsService>();

Methods

| Improve this Doc View Source

Get(Int32, KeyboardShortcutsIncludeOptions)

Gets the list of KeyboardShortcut for the workspace.

Declaration
IEnumerable<KeyboardShortcut> Get(int workspaceId, KeyboardShortcutsIncludeOptions includeOptions = null)
Parameters
Type Name Description
System.Int32 workspaceId

The workspace Artifact ID. Don't use admin level context specified by -1.
KeyboardShortcutsIncludeOptions includeOptions

Optional parameters indicating wheter to include specified types of shortcuts.
Returns
Type Description
System.Collections.Generic.IEnumerable<KeyboardShortcut>

The collection of KeyboardShortcut entities.
Examples
var workspaceId = 1015427;
var includeOptions = new KeyboardShortcutsIncludeOptions
{
	IncludeSystemShortcuts = false,
	IncludeFieldShortcuts = false
};
var keyboardShortcuts = _keyboardShortcutsService.Get(workspaceId, includeOptions);