Method: Appium::Driver#log_event

Defined in:
lib/appium_lib/driver.rb

#log_event(vendor:, event:) ⇒ nil

Logs a custom event. The event is available via Core::Events#get.

Examples:


log_event vendor: 'appium', event: 'funEvent'

log_event = { vendor: 'appium', event: 'anotherEvent' }
log_events #=> {...., 'appium:funEvent' => [1572957315, 1572960305],
           #          'appium:anotherEvent' => 1572959315}

Parameters:

  • vendor (String)

    The vendor prefix for the event

  • event (String)

    The name of event

Returns:

  • (nil)

Raises:

Since:

  • Appium 1.16.0


856
857
858
859
860
# File 'lib/appium_lib/driver.rb', line 856

def log_event(vendor:, event:)
  raise NoDriverInstanceError if @driver.nil?

  @driver.logs.event vendor: vendor, event: event
end