SP.WorkManagement.OM.BaseSession object (sp.workmanagement)

Represents the base session to access work management tasks.

Applies to: apps for SharePoint | SharePoint Foundation 2013 | SharePoint Server 2013

var object = new SP.WorkManagement.OM.BaseSession()

Members

The BaseSession object has the following members.

Constructor

The BaseSession object has the following constructor.

Constructor

Description

BaseSession

Initializes a new instance of the BaseSession object.

Methods

The BaseSession object has the following methods.

Method

Description

addAttributeToTask

Adds an attribute to the task.

beginCacheRefresh

Starts a cache refresh job that will start farm level refresh jobs on the My farm.

beginExchangeSync

Starts the Exchange synchronization process.

createPersonalTaskAndPromoteToProviderTask

Creates a new personal task and then tries to promote it to the provider specified by the locationKey parameter.

createTask

Creates a new task.

deleteTask

Deletes a task.

getCalloutInfo

Gets the information for the task callout.

getRefreshHealthInfo

Returns information about the state of the last refresh operation.

getRefreshHistory

Returns information about the latest task cache refresh.

getRefreshStatus

Returns the status of a refresh operation.

isExchangeJobPending

Returns true if the synchronization process is in progress for the user; otherwise false.

pinTask

Marks a task as pinned and adds the task to the timeline.

promotePersonalTaskToProviderTaskInLocation

The promotePersonalTaskToProviderTaskInLocation method makes a copy of the specified task in the data source of the specified location and links it to the AWIOP representation.

readAllNonTaskData

Gets information about a user’s task settings that is not specific to tasks themselves.

refreshSingleTask

Refreshes a single task.

removeAttributeFromTask

Removes an attribute from a task.

removePinOnTask

Removes the pin from a task.

updateTaskWithLocalizedValue

Updates a field of the task with a string represented in the locale of the protocol client.

Properties

The BaseSession object has the following properties.