Difference between revisions of "Ads:checkConsent"

From GiderosMobile
(Created page with "__NOTOC__ '''Available since:''' Gideros 2023.8<br/> '''Class:''' Ads<br/> === Description === Triggers consent check and flow, if any supported by the Ad engine. <syntax...")
 
 
(One intermediate revision by the same user not shown)
Line 9: Line 9:
 
</syntaxhighlight>
 
</syntaxhighlight>
  
The '''parameters''' table is mandatory and can contain the following fields:
+
The '''parameters''' table is mandatory and can contain the following fields:<br/>
- '''reset''': (boolean) Reset saved consent information, for testing purposes
+
- '''reset''': (boolean) Reset saved consent information, for testing purposes<br/>
- '''underAge''': (boolean) Tells if the user is under age as per the Ad engine guidelines
+
- '''underAge''': (boolean) Tells if the user is under age as per the Ad engine guidelines<br/>
  
 
=== Parameters ===
 
=== Parameters ===
 
'''parameters''': (table) consent options<br/>
 
'''parameters''': (table) consent options<br/>
 +
 +
=== Return values ===
 +
'''Returns''' (boolean) ''true'' if consent flow is supported and if an [[Event.AD_CONSENT]] event will be triggered, ''false'' otherwise.
  
 
{{Ads}}
 
{{Ads}}

Latest revision as of 08:27, 18 August 2023

Available since: Gideros 2023.8
Class: Ads

Description

Triggers consent check and flow, if any supported by the Ad engine.

Ads:checkConsent(parameters)

The parameters table is mandatory and can contain the following fields:
- reset: (boolean) Reset saved consent information, for testing purposes
- underAge: (boolean) Tells if the user is under age as per the Ad engine guidelines

Parameters

parameters: (table) consent options

Return values

Returns (boolean) true if consent flow is supported and if an Event.AD_CONSENT event will be triggered, false otherwise.