Class: IABConsentString::Consent::VendorConsent

Inherits:
Object
  • Object
show all
Defined in:
lib/iab_consent_string/consent/vendor_consent.rb

Instance Method Summary collapse

Instance Method Details

#getAllowedPurposes ⇒ Set<Purpose>

Returns the set of allowed purposes which are permitted according to this consent string.

Returns:

  • (Set<Purpose>) —

    the set of allowed purposes which are permitted according to this consent string

Raises:

  • (NotImplementedError) 


50
51
52
 
# File 'lib/iab_consent_string/consent/vendor_consent.rb', line 50

def getAllowedPurposes
  raise NotImplementedError
end

#getAllowedPurposesBits ⇒ Integer

Returns an integer equivalent of allowed purpose id bits according to this consent string.

Returns:

  • (Integer) —

    an integer equivalent of allowed purpose id bits according to this consent string

Raises:

  • (NotImplementedError) 


55
56
57
 
# File 'lib/iab_consent_string/consent/vendor_consent.rb', line 55

def getAllowedPurposesBits
  raise NotImplementedError
end

#getAllowedPurposesIds ⇒ Set<Integer>

Returns the set of purpose id’s which are permitted according to this consent string.

Returns:

  • (Set<Integer>) —

    the set of purpose id’s which are permitted according to this consent string

Raises:

  • (NotImplementedError) 


45
46
47
 
# File 'lib/iab_consent_string/consent/vendor_consent.rb', line 45

def getAllowedPurposesIds
  raise NotImplementedError
end

#getCmpId ⇒ Integer

Returns the Consent Manager Provider ID that last updated the consent string.

Returns:

  • (Integer) —

    the Consent Manager Provider ID that last updated the consent string

Raises:

  • (NotImplementedError) 


20
21
22
 
# File 'lib/iab_consent_string/consent/vendor_consent.rb', line 20

def getCmpId
  raise NotImplementedError
end

#getCmpVersion ⇒ Integer

Returns the Consent Manager Provider version.

Returns:

  • (Integer) —

    the Consent Manager Provider version

Raises:

  • (NotImplementedError) 


25
26
27
 
# File 'lib/iab_consent_string/consent/vendor_consent.rb', line 25

def getCmpVersion
  raise NotImplementedError
end

#getConsentLanguage ⇒ Char(2)

Returns the two-letter ISO639-1 language code that CMP asked for consent in.

Returns:

  • (Char(2)) —

    the two-letter ISO639-1 language code that CMP asked for consent in

Raises:

  • (NotImplementedError) 


35
36
37
 
# File 'lib/iab_consent_string/consent/vendor_consent.rb', line 35

def getConsentLanguage
  raise NotImplementedError
end

#getConsentRecordCreated ⇒ Timestamp

Returns the time (milli since epoch) at which the consent string was created.

Returns:

  • (Timestamp) —

    the time (milli since epoch) at which the consent string was created

Raises:

  • (NotImplementedError) 


10
11
12
 
# File 'lib/iab_consent_string/consent/vendor_consent.rb', line 10

def getConsentRecordCreated
  raise NotImplementedError
end

#getConsentRecordLastUpdated ⇒ Timestamp

Returns the time (milli since epoch) at which the consent string was last updated.

Returns:

  • (Timestamp) —

    the time (milli since epoch) at which the consent string was last updated

Raises:

  • (NotImplementedError) 


15
16
17
 
# File 'lib/iab_consent_string/consent/vendor_consent.rb', line 15

def getConsentRecordLastUpdated
  raise NotImplementedError
end

#getConsentScreen ⇒ Integer

Returns the screen number in the CMP where consent was given.

Returns:

  • (Integer) —

    the screen number in the CMP where consent was given

Raises:

  • (NotImplementedError) 


30
31
32
 
# File 'lib/iab_consent_string/consent/vendor_consent.rb', line 30

def getConsentScreen
  raise NotImplementedError
end

#getMaxVendorId ⇒ Integer

Returns the maximum VendorId for which consent values are given.

Returns:

  • (Integer) —

    the maximum VendorId for which consent values are given.

Raises:

  • (NotImplementedError) 


60
61
62
 
# File 'lib/iab_consent_string/consent/vendor_consent.rb', line 60

def getMaxVendorId
  raise NotImplementedError
end

#getVendorListVersion ⇒ Integer

Returns version of vendor list used in most recent consent string update.

Returns:

  • (Integer) —

    version of vendor list used in most recent consent string update.

Raises:

  • (NotImplementedError) 


40
41
42
 
# File 'lib/iab_consent_string/consent/vendor_consent.rb', line 40

def getVendorListVersion
  raise NotImplementedError
end

#getVersion ⇒ Integer

Returns the version of consent string format.

Returns:

  • (Integer) —

    the version of consent string format

Raises:

  • (NotImplementedError) 


5
6
7
 
# File 'lib/iab_consent_string/consent/vendor_consent.rb', line 5

def getVersion
  raise NotImplementedError
end

#isPurposeAllowed(purpose) ⇒ Boolean

Check wether specified purpose is allowed

Parameters:

  • purpose (Purpose) —

    purpose to check

Returns:

  • (Boolean) —

    true if purpose is allowed in this consent, false otherwise

Raises:

  • (NotImplementedError) 


74
75
76
 
# File 'lib/iab_consent_string/consent/vendor_consent.rb', line 74

def isPurposeAllowed(purpose)
  raise NotImplementedError
end

#isPurposeIdAllowed(purposeId) ⇒ Boolean

Check wether purpose with specified ID is allowed

Parameters:

  • purposeId (Integer) —

    purpose ID

Returns:

  • (Boolean) —

    true if purpose is allowed in this consent, false otherwise

Raises:

  • (NotImplementedError) 


67
68
69
 
# File 'lib/iab_consent_string/consent/vendor_consent.rb', line 67

def isPurposeIdAllowed(purposeId)
  raise NotImplementedError
end

#isVendorAllowed(vendorId) ⇒ Boolean

Check wether vendor with specified ID is allowed

Parameters:

  • vendorId (Integer) —

    vendor ID

Returns:

  • (Boolean) —

    true if vendor is allowed in this consent, false otherwise

Raises:

  • (NotImplementedError) 


81
82
83
 
# File 'lib/iab_consent_string/consent/vendor_consent.rb', line 81

def isVendorAllowed(vendorId)
  raise NotImplementedError
end

#toByteArray ⇒ Array<Byte>

Returns the value of this consent as byte array.

Returns:

  • (Array<Byte>) —

    the value of this consent as byte array

Raises:

  • (NotImplementedError) 


86
87
88
 
# File 'lib/iab_consent_string/consent/vendor_consent.rb', line 86

def toByteArray
  raise NotImplementedError
end