Class: ScreenShotStatus

Inherits:
Object
  • Object
show all
Defined in:
lib/screenshotstatus.rb

Overview

This class represents the screenshot status

Author:

Version:

Instance Method Summary (collapse)

Constructor Details

- (ScreenShotStatus) initialize(processing = false, cached = false, expired = false, message = '')

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

A new instance of ScreenShotStatus



6
7
8
9
10
11
# File 'lib/screenshotstatus.rb', line 6

def initialize(processing = false, cached = false, expired = false, message = '')
	@Processing = processing
	@Cached = cached
	@Expired = expired
	@Message = message
end

Instance Method Details

- (Boolean) cached

If true the screenshot has been cached

Returns:

  • (Boolean)

    if true the screenshot has been cached



17
18
19
# File 'lib/screenshotstatus.rb', line 17

def cached
	@Cached
end

- (Boolean) expired

If true the screenshot has expired

Returns:

  • (Boolean)

    if true the screenshot has expired



21
22
23
# File 'lib/screenshotstatus.rb', line 21

def expired
	@Expired
end

- (String) message

Returns any error messages associated with the screenshot

Returns:

  • (String)

    returns any error messages associated with the screenshot



25
26
27
# File 'lib/screenshotstatus.rb', line 25

def message
	@Message
end

- (Boolean) processing

If true the screenshot is still being processed

Returns:

  • (Boolean)

    if true the screenshot is still being processed



13
14
15
# File 'lib/screenshotstatus.rb', line 13

def processing
	@Processing
end