Class: GrabzIt::BaseOptions

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

Overview

Author:

  • GrabzIt

Instance Method Summary collapse

Instance Method Details

#country ⇒ String

Returns the country the capture should be created from.

Returns:

  • (String) —

    the country the capture should be created from.



30
31
32
 
# File 'lib/grabzit/baseoptions.rb', line 30

def country
	@country
end

#country=(value) ⇒ void

This method returns an undefined value.

Set the country the capture should be created from: Default = “”, Singapore = “SG”, UK = “UK”, US = “US”.

Parameters:

  • value (String) —

    the country to use



38
39
40
 
# File 'lib/grabzit/baseoptions.rb', line 38

def country=(value)
	@country = value
end

#customId ⇒ String

Returns the custom identifier that you can pass through to the web service.

Returns:

  • (String) —

    the custom identifier that you can pass through to the web service.



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

def customId
	@customId
end

#customId=(value) ⇒ void

This method returns an undefined value.

Set a custom identifier to pass to the web service. This will be returned with the callback URL you have specified.

Parameters:

  • value (String) —

    the custom identifier



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

def customId=(value)
	@customId = value
end

#encryptionKey ⇒ String

Returns the encryption key that will be used to encrypt your capture.

Returns:

  • (String) —

    the encryption key that will be used to encrypt your capture.



56
57
58
 
# File 'lib/grabzit/baseoptions.rb', line 56

def encryptionKey
	@encryptionKey
end

#encryptionKey=(value) ⇒ void

This method returns an undefined value.

Set the encryption key that will be used to encrypt your capture.

Parameters:

  • value (String) —

    encryption key to use



64
65
66
 
# File 'lib/grabzit/baseoptions.rb', line 64

def encryptionKey=(value)
	@encryptionKey = value
end

#exportURL ⇒ String

Returns the export URL that should be used to transfer the capture to a third party location.

Returns:

  • (String) —

    the export URL that should be used to transfer the capture to a third party location.



43
44
45
 
# File 'lib/grabzit/baseoptions.rb', line 43

def exportURL
	@exportURL
end

#exportURL=(value) ⇒ void

This method returns an undefined value.

Set the export URL that should be used to transfer the capture to a third party location.

Parameters:

  • value (String) —

    export URL to use



51
52
53
 
# File 'lib/grabzit/baseoptions.rb', line 51

def exportURL=(value)
	@exportURL = value
end

#proxy ⇒ String

Returns the HTTP proxy that should be used to create the capture.

Returns:

  • (String) —

    the HTTP proxy that should be used to create the capture.



69
70
71
 
# File 'lib/grabzit/baseoptions.rb', line 69

def proxy
	@proxy
end

#proxy=(value) ⇒ void

This method returns an undefined value.

Set the HTTP proxy that should be used to create the capture.

Parameters:

  • value (String) —

    HTTP proxy to use



77
78
79
 
# File 'lib/grabzit/baseoptions.rb', line 77

def proxy=(value)
	@proxy = value
end