Class: Mailkube::Events::EngagementContext

Inherits:
Node
  • Object
show all
Defined in:
lib/mailkube/events/contexts.rb,
sig/mailkube/events/contexts.rbs

Overview

An open interaction (email.opened).

These nested keys are camelCase on the wire, unlike every other block here. The SDK mirrors the server rather than normalizing it.

Direct Known Subclasses

ClickContext

Instance Attribute Summary

Attributes inherited from Node

#raw

Instance Method Summary collapse

Methods inherited from Node

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

Constructor Details

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

Instance Method Details

#ip_address ⇒ String

Returns the opening client's IP address (wire key ipAddress).

Returns:

  • (String) —

    the opening client's IP address (wire key ipAddress).



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

def ip_address = self["ipAddress"]
# @return [String] the opening client's user agent (wire key `userAgent`).

#timestamp ⇒ String

Returns when the interaction was recorded.

Returns:

  • (String) —

    when the interaction was recorded.



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

def timestamp = self["timestamp"]

#user_agent ⇒ String

Returns the opening client's user agent (wire key userAgent).

Returns:

  • (String) —

    the opening client's user agent (wire key userAgent).



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

def user_agent = self["userAgent"]
# @return [String] when the interaction was recorded.