Class: Mailkube::Events::ScheduledContext

Inherits:

Node

• Object
• Node
• Mailkube::Events::ScheduledContext

Defined in:

lib/mailkube/events/contexts.rb,
sig/mailkube/events/contexts.rbs

Overview

When a scheduled send is due (email.scheduled).

Unlike the engagement blocks, these keys are snake_case on the wire.

Instance Attribute Summary

Attributes inherited from Node

#raw

Instance Method Summary

• #batch_id ⇒ String^?

  The batch label the send was grouped under.

• #scheduled_at ⇒ String

  When the send is due.

Methods inherited from Node

#==, #[], #block, #hash, #initialize, #to_h

Constructor Details

This class inherits a constructor from Mailkube::Events::Node

Instance Method Details

#batch_id ⇒ String^?

Returns the batch label the send was grouped under.

Returns:

• (String, nil) —

  the batch label the send was grouped under.

# File 'lib/mailkube/events/contexts.rb', line 95

def batch_id = self["batch_id"]

#scheduled_at ⇒ String

Returns when the send is due.

Returns:

• (String) —

  when the send is due.

# File 'lib/mailkube/events/contexts.rb', line 93

def scheduled_at = self["scheduled_at"]
# @return [String, nil] the batch label the send was grouped under.