Class WorkspaceUpdater

    • Constructor Detail

      • WorkspaceUpdater

        public WorkspaceUpdater​(String pathSid)
        Construct a new WorkspaceUpdater.
        Parameters:
        pathSid - The sid
    • Method Detail

      • setDefaultActivitySid

        public WorkspaceUpdater setDefaultActivitySid​(String defaultActivitySid)
        The ID of the Activity that will be used when new Workers are created in this Workspace..
        Parameters:
        defaultActivitySid - The ID of the Activity that will be used when new Workers are created in this Workspace.
        Returns:
        this
      • setEventCallbackUrl

        public WorkspaceUpdater setEventCallbackUrl​(URI eventCallbackUrl)
        The Workspace will publish events to this URL. You can use this to gather data for reporting. See [Events][/docs/taskrouter/api/events] for more information..
        Parameters:
        eventCallbackUrl - The Workspace will publish events to this URL.
        Returns:
        this
      • setEventCallbackUrl

        public WorkspaceUpdater setEventCallbackUrl​(String eventCallbackUrl)
        The Workspace will publish events to this URL. You can use this to gather data for reporting. See [Events][/docs/taskrouter/api/events] for more information..
        Parameters:
        eventCallbackUrl - The Workspace will publish events to this URL.
        Returns:
        this
      • setEventsFilter

        public WorkspaceUpdater setEventsFilter​(String eventsFilter)
        Use this parameter to receive webhooks on EventCallbackUrl for specific events on a workspace. For example if 'EventsFilter=task.created,task.canceled,worker.activity.update', then TaskRouter will webhook to EventCallbackUrl only when a task is created, canceled or a worker activity is updated..
        Parameters:
        eventsFilter - Use this parameter to receive webhooks on EventCallbackUrl for specific events on a workspace.
        Returns:
        this
      • setFriendlyName

        public WorkspaceUpdater setFriendlyName​(String friendlyName)
        Human readable description of this workspace (for example "Sales Call Center" or "Customer Support Team").
        Parameters:
        friendlyName - Human readable description of this workspace
        Returns:
        this
      • setMultiTaskEnabled

        public WorkspaceUpdater setMultiTaskEnabled​(Boolean multiTaskEnabled)
        Enable or Disable Multitasking by passing either *true* or *False* with the POST request. Learn more by visiting [Multitasking][/docs/taskrouter/multitasking]..
        Parameters:
        multiTaskEnabled - Enable or Disable Multitasking by passing either true or False with the POST request.
        Returns:
        this
      • setTimeoutActivitySid

        public WorkspaceUpdater setTimeoutActivitySid​(String timeoutActivitySid)
        The ID of the Activity that will be assigned to a Worker when a Task reservation times out without a response..
        Parameters:
        timeoutActivitySid - The ID of the Activity that will be assigned to a Worker when a Task reservation times out without a response.
        Returns:
        this
      • setPrioritizeQueueOrder

        public WorkspaceUpdater setPrioritizeQueueOrder​(Workspace.QueueOrder prioritizeQueueOrder)
        Use this parameter to configure whether to prioritize LIFO or FIFO when workers are receiving Tasks from combination of LIFO and FIFO TaskQueues. Default is FIFO. [Click here][/docs/taskrouter/queue-ordering-last-first-out-lifo] to learn more about LIFO and the use of the parameter..
        Parameters:
        prioritizeQueueOrder - Use this parameter to configure whether to prioritize LIFO or FIFO when workers are receiving Tasks from combination of LIFO and FIFO TaskQueues.
        Returns:
        this
      • update

        public Workspace update​(TwilioRestClient client)
        Make the request to the Twilio API to perform the update.
        Specified by:
        update in class Updater<Workspace>
        Parameters:
        client - TwilioRestClient with which to make the request
        Returns:
        Updated Workspace