# GoogleUserMessagingPlatform Framework Reference

# UMPConsentInformation


    @interface UMPConsentInformation : NSObject

Consent information. All methods must be called on the main thread.
- `


  ### [sharedInstance](https://developers.google.com/admob/ios/privacy/api/reference/Classes/UMPConsentInformation#/c:objc(cs)UMPConsentInformation(cpy)sharedInstance)


  ` The shared consent information instance.

  #### Declaration

  Swift

      class var shared: ConsentInformation { get }

  Objective-C

      @property (class, nonatomic, readonly, nonnull) UMPConsentInformation *sharedInstance;

- `


  ### [consentStatus](https://developers.google.com/admob/ios/privacy/api/reference/Classes/UMPConsentInformation#/c:objc(cs)UMPConsentInformation(py)consentStatus)


  ` The user's consent status. This value defaults to UMPConsentStatusUnknown until
  requestConsentInfoUpdateWithParameters:completionHandler: is called, and defaults to the
  previous session's value until \|completionHandler\| from
  requestConsentInfoUpdateWithParameters:completionHandler: is called.

  #### Declaration

  Swift

      var consentStatus: ConsentStatus { get }

  Objective-C

      @property (nonatomic, readonly) https://developers.google.com/admob/ios/privacy/api/reference/Enums/UMPConsentStatus.html consentStatus;

- `


  ### [canRequestAds](https://developers.google.com/admob/ios/privacy/api/reference/Classes/UMPConsentInformation#/c:objc(cs)UMPConsentInformation(py)canRequestAds)


  ` Indicates whether the SDK has gathered consent aligned with the app's configured messages.
  Returns NO until requestConsentInfoUpdateWithParameters:completionHandler: is called.

  #### Declaration

  Swift

      var canRequestAds: Bool { get }

  Objective-C

      @property (nonatomic, readonly) BOOL canRequestAds;

- `


  ### [formStatus](https://developers.google.com/admob/ios/privacy/api/reference/Classes/UMPConsentInformation#/c:objc(cs)UMPConsentInformation(py)formStatus)


  ` Consent form status. This value defaults to UMPFormStatusUnknown and requires a call to
  requestConsentInfoUpdateWithParameters:completionHandler: to update.

  #### Declaration

  Swift

      var formStatus: FormStatus { get }

  Objective-C

      @property (nonatomic, readonly) https://developers.google.com/admob/ios/privacy/api/reference/Enums/UMPFormStatus.html formStatus;

- `


  ### [privacyOptionsRequirementStatus](https://developers.google.com/admob/ios/privacy/api/reference/Classes/UMPConsentInformation#/c:objc(cs)UMPConsentInformation(py)privacyOptionsRequirementStatus)


  ` Privacy options requirement status. This value defaults to
  UMPPrivacyOptionsRequirementStatusUnknown until
  requestConsentInfoUpdateWithParameters:completionHandler: is called, and defaults to the
  previous session's value until \|completionHandler\| from
  requestConsentInfoUpdateWithParameters:completionHandler: is called.

  #### Declaration

  Swift

      var privacyOptionsRequirementStatus: PrivacyOptionsRequirementStatus { get }

  Objective-C

      @property (nonatomic, readonly) https://developers.google.com/admob/ios/privacy/api/reference/Enums/UMPPrivacyOptionsRequirementStatus.html privacyOptionsRequirementStatus;

- `


  ### [-requestConsentInfoUpdateWithParameters:completionHandler:](https://developers.google.com/admob/ios/privacy/api/reference/Classes/UMPConsentInformation#/c:objc(cs)UMPConsentInformation(im)requestConsentInfoUpdateWithParameters:completionHandler:)


  ` Requests consent information update. Must be called in every app session before checking the
  user's consentStatus or loading a consent form. After calling this method, consentStatus will be
  updated synchronously to hold the consent state from the previous app session, if one exists.
  consentStatus may be updated again immediately before the completion handler is called.

  #### Declaration

  Swift

      func requestConsentInfoUpdate(with parameters: RequestParameters?) async throws

  Objective-C

      - (void)
          requestConsentInfoUpdateWithParameters:
              (nullable https://developers.google.com/admob/ios/privacy/api/reference/Classes/UMPRequestParameters.html *)parameters
                               completionHandler:
                                   (nonnull
                                        https://developers.google.com/admob/ios/privacy/api/reference/Type-Definitions.html#/c:UMPConsentInformation.h@T@UMPConsentInformationUpdateCompletionHandler)
                                       handler;

- `


  ### [-reset](https://developers.google.com/admob/ios/privacy/api/reference/Classes/UMPConsentInformation#/c:objc(cs)UMPConsentInformation(im)reset)


  ` Clears all consent state from persistent storage.

  #### Declaration

  Swift

      func reset()

  Objective-C

      - (void)reset;