Class: Twilio::REST::Taskrouter::V1::WorkspaceContext::ActivityInstance

Inherits:

InstanceResource

• Object
• InstanceResource
• Twilio::REST::Taskrouter::V1::WorkspaceContext::ActivityInstance

Defined in:

lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb

Instance Method Summary

• #account_sid ⇒ String

  The SID of the Account that created the resource.

• #available ⇒ Boolean

  Whether the Worker should be eligible to receive a Task when it occupies the Activity.

• #context ⇒ ActivityContext

  Generate an instance context for the instance, the context is capable of performing various actions.

• #date_created ⇒ Time

  The ISO 8601 date and time in GMT when the resource was created.

• #date_updated ⇒ Time

  The ISO 8601 date and time in GMT when the resource was last updated.

• #delete ⇒ Boolean

  Delete the ActivityInstance.

• #fetch ⇒ ActivityInstance

  Fetch the ActivityInstance.

• #friendly_name ⇒ String

  The string that you assigned to describe the Activity resource.

• #initialize(version, payload, workspace_sid: nil, sid: nil) ⇒ ActivityInstance constructor

  Initialize the ActivityInstance.

• #inspect ⇒ Object

  Provide a detailed, user friendly representation.

• #sid ⇒ String

  The unique string that identifies the resource.

• #to_s ⇒ Object

  Provide a user friendly representation.

• #update(friendly_name: :unset) ⇒ ActivityInstance

  Update the ActivityInstance.

• #url ⇒ String

  The absolute URL of the Activity resource.

• #workspace_sid ⇒ String

  The SID of the Workspace that contains the Activity.

Constructor Details

#initialize(version, payload, workspace_sid: nil, sid: nil) ⇒ ActivityInstance

Initialize the ActivityInstance

# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 271

def initialize(version, payload, workspace_sid: nil, sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'account_sid' => payload['account_sid'],
      'available' => payload['available'],
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
      'friendly_name' => payload['friendly_name'],
      'sid' => payload['sid'],
      'workspace_sid' => payload['workspace_sid'],
      'url' => payload['url'],
  }

  # Context
  @instance_context = nil
  @params = {'workspace_sid' => workspace_sid, 'sid' => sid || @properties['sid'], }
end

Instance Method Details

#account_sid ⇒ String

# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 304

def account_sid
  @properties['account_sid']
end

#available ⇒ Boolean

# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 310

def available
  @properties['available']
end

#context ⇒ ActivityContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 295

def context
  unless @instance_context
    @instance_context = ActivityContext.new(@version, @params['workspace_sid'], @params['sid'], )
  end
  @instance_context
end

#date_created ⇒ Time

# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 316

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 322

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Delete the ActivityInstance

# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 372

def delete
  context.delete
end

#fetch ⇒ ActivityInstance

Fetch the ActivityInstance

# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 353

def fetch
  context.fetch
end

#friendly_name ⇒ String

# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 328

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation

# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 385

def inspect
  values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Taskrouter.V1.ActivityInstance #{values}>"
end

#sid ⇒ String

# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 334

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation

# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 378

def to_s
  values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Taskrouter.V1.ActivityInstance #{values}>"
end

#update(friendly_name: :unset) ⇒ ActivityInstance

Update the ActivityInstance

# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 365

def update(friendly_name: :unset)
  context.update(friendly_name: friendly_name, )
end

#url ⇒ String

# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 346

def url
  @properties['url']
end

#workspace_sid ⇒ String

# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 340

def workspace_sid
  @properties['workspace_sid']
end