ProjectDocument.getWSSUrlAsync method

Asynchronously gets the URL of the synchronized SharePoint task list.

Hosts: Project
Available in Requirement set Selection
Added in 1.0
Office.context.document.getWSSUrlAsync([options,] [callback]);

Parameters

Name Type Description Support notes
options object Specifies any of the following optional parameters.
asyncContext array, boolean, null, number, object, string, or undefined A user-defined item of any type that is returned in the AsyncResult object without being altered.
callback object A function that is invoked when the callback returns, whose only parameter is of type AsyncResult.

Callback Value

When the callback function executes, it receives an AsyncResult object that you can access from the parameter in the callback function.

For the getWSSUrlAsync method, the returned AsyncResult object contains following properties.

Name Description
asyncContext The data passed in the optional asyncContext parameter, if the parameter was used.
error Information about the error, if the status property equals failed.
status The succeeded or failed status of the asynchronous call.
value Contains the following properties:

  • The listName property is the name of the synchronized SharePoint task list.
  • The serverUrl property is the URL of the synchronized SharePoint task list.

Remarks

If the active project is not synchronized with a SharePoint task list, the listName and serverUrl values are empty.

Example

The following code example calls getWSSUrlAsync to get the name and URL of the synchronized SharePoint task list.

The example assumes your add-in has a reference to the jQuery library and that the following page control is defined in the content div in the page body.

<span id="message"></span>
(function () {
    "use strict";

    // The initialize function must be run each time a new page is loaded.
    Office.initialize = function (reason) {
        $(document).ready(function () {

            // After the DOM is loaded, add-in-specific code can run.
            getSharePointTaskListUrl();
        });
    };

    // Get the URL of the the synchronized SharePoint task list.
    function getSharePointTaskListUrl() {
        Office.context.document.getWSSUrlAsync(
            function (result) {
                if (result.status === Office.AsyncResultStatus.Succeeded) {
                    var output = String.format(
                        'List name: {0}<br />List URL: {1}',
                        result.value.listName, result.value.serverUrl);
                    $('#message').html(output);
                }
                else {
                    onError(result.error);
                }
            }
        );
    }

    function onError(error) {
        $('#message').html(error.name + ' ' + error.code + ': ' + error.message);
    }
})();

Support details

A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this method.

For more information about Office host application and server requirements, see Requirements for running Office Add-ins.

Office for Windows desktop Office Online (in browser)
Project Y
Available in requirement sets
Minimum permission level ReadDocument
Add-in types Task pane
Library Office.js
Namespace Office

Support history

Version Changes
1.0 Introduced

See also

Other resources

AsyncResult object ProjectDocument object