ProtectedSignalsManager.xml

<Type Name="ProtectedSignalsManager" FullName="Android.AdServices.Signals.ProtectedSignalsManager">
  <TypeSignature Language="C#" Value="public class ProtectedSignalsManager : Java.Lang.Object" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ProtectedSignalsManager extends Java.Lang.Object" />
  <TypeSignature Language="DocId" Value="T:Android.AdServices.Signals.ProtectedSignalsManager" />
  <TypeSignature Language="F#" Value="type ProtectedSignalsManager = class&#xA;    inherit Object" />
  <AssemblyInfo>
    <AssemblyName>Mono.Android</AssemblyName>
    <AssemblyVersion>0.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>Java.Lang.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Attributes>
    <Attribute>
      <AttributeName Language="C#">[Android.Runtime.Register("android/adservices/signals/ProtectedSignalsManager", ApiSince=35, DoNotGenerateAcw=true)]</AttributeName>
      <AttributeName Language="F#">[&lt;Android.Runtime.Register("android/adservices/signals/ProtectedSignalsManager", ApiSince=35, DoNotGenerateAcw=true)&gt;]</AttributeName>
    </Attribute>
    <Attribute>
      <AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(0)]</AttributeName>
      <AttributeName Language="F#">[&lt;System.Runtime.CompilerServices.Nullable(0)&gt;]</AttributeName>
    </Attribute>
    <Attribute>
      <AttributeName Language="C#">[System.Runtime.Versioning.SupportedOSPlatform("android35.0")]</AttributeName>
      <AttributeName Language="F#">[&lt;System.Runtime.Versioning.SupportedOSPlatform("android35.0")&gt;]</AttributeName>
    </Attribute>
  </Attributes>
  <Docs>
    <summary>ProtectedSignalsManager provides APIs for apps and ad-SDKs to manage their protected signals.</summary>
    <remarks>
      <para>ProtectedSignalsManager provides APIs for apps and ad-SDKs to manage their protected signals.</para>
      <para>
        <format type="text/html">
          <a href="https://developer.android.com/reference/android/adservices/signals/ProtectedSignalsManager" title="Reference documentation">Java documentation for <code>android.adservices.signals.ProtectedSignalsManager</code>.</a>
        </format>
      </para>
      <para>
                    Portions of this page are modifications based on work created and shared by the 
                    <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
                     and used according to terms described in the 
                    <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
    </remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="protected ProtectedSignalsManager (IntPtr javaReference, Android.Runtime.JniHandleOwnership transfer);" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(native int javaReference, valuetype Android.Runtime.JniHandleOwnership transfer) cil managed" />
      <MemberSignature Language="DocId" Value="M:Android.AdServices.Signals.ProtectedSignalsManager.#ctor(System.IntPtr,Android.Runtime.JniHandleOwnership)" />
      <MemberSignature Language="F#" Value="new Android.AdServices.Signals.ProtectedSignalsManager : nativeint * Android.Runtime.JniHandleOwnership -&gt; Android.AdServices.Signals.ProtectedSignalsManager" Usage="new Android.AdServices.Signals.ProtectedSignalsManager (javaReference, transfer)" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Mono.Android</AssemblyName>
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="javaReference" Type="System.IntPtr" />
        <Parameter Name="transfer" Type="Android.Runtime.JniHandleOwnership" />
      </Parameters>
      <Docs>
        <param name="javaReference">To be added.</param>
        <param name="transfer">To be added.</param>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Get">
      <MemberSignature Language="C#" Value="public static Android.AdServices.Signals.ProtectedSignalsManager Get (Android.Content.Context context);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Android.AdServices.Signals.ProtectedSignalsManager Get(class Android.Content.Context context) cil managed" />
      <MemberSignature Language="DocId" Value="M:Android.AdServices.Signals.ProtectedSignalsManager.Get(Android.Content.Context)" />
      <MemberSignature Language="F#" Value="static member Get : Android.Content.Context -&gt; Android.AdServices.Signals.ProtectedSignalsManager" Usage="Android.AdServices.Signals.ProtectedSignalsManager.Get context" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Mono.Android</AssemblyName>
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[Android.Runtime.Register("get", "(Landroid/content/Context;)Landroid/adservices/signals/ProtectedSignalsManager;", "", ApiSince=35)]</AttributeName>
          <AttributeName Language="F#">[&lt;Android.Runtime.Register("get", "(Landroid/content/Context;)Landroid/adservices/signals/ProtectedSignalsManager;", "", ApiSince=35)&gt;]</AttributeName>
        </Attribute>
        <Attribute>
          <AttributeName Language="C#">[System.Runtime.Versioning.SupportedOSPlatform("android35.0")]</AttributeName>
          <AttributeName Language="F#">[&lt;System.Runtime.Versioning.SupportedOSPlatform("android35.0")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>Android.AdServices.Signals.ProtectedSignalsManager</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="context" Type="Android.Content.Context" />
      </Parameters>
      <Docs>
        <param name="context">The <c>Context</c> to use</param>
        <summary>Factory method for creating an instance of ProtectedSignalsManager.</summary>
        <returns>A <c>ProtectedSignalsManager</c> instance</returns>
        <remarks>
          <para>Factory method for creating an instance of ProtectedSignalsManager.</para>
          <para>
            <format type="text/html">
              <a href="https://developer.android.com/reference/android/adservices/signals/ProtectedSignalsManager#get(android.content.Context)" title="Reference documentation">Java documentation for <code>android.adservices.signals.ProtectedSignalsManager.get(android.content.Context)</code>.</a>
            </format>
          </para>
          <para>
                    Portions of this page are modifications based on work created and shared by the 
                    <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
                     and used according to terms described in the 
                    <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="JniPeerMembers">
      <MemberSignature Language="C#" Value="public override Java.Interop.JniPeerMembers JniPeerMembers { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class Java.Interop.JniPeerMembers JniPeerMembers" />
      <MemberSignature Language="DocId" Value="P:Android.AdServices.Signals.ProtectedSignalsManager.JniPeerMembers" />
      <MemberSignature Language="F#" Value="member this.JniPeerMembers : Java.Interop.JniPeerMembers" Usage="Android.AdServices.Signals.ProtectedSignalsManager.JniPeerMembers" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Mono.Android</AssemblyName>
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
          <AttributeName Language="F#">[&lt;System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)&gt;]</AttributeName>
        </Attribute>
        <Attribute>
          <AttributeName Language="C#">[System.Diagnostics.DebuggerBrowsable(System.Diagnostics.DebuggerBrowsableState.Never)]</AttributeName>
          <AttributeName Language="F#">[&lt;System.Diagnostics.DebuggerBrowsable(System.Diagnostics.DebuggerBrowsableState.Never)&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>Java.Interop.JniPeerMembers</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>To be added.</summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ThresholdClass">
      <MemberSignature Language="C#" Value="protected override IntPtr ThresholdClass { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance native int ThresholdClass" />
      <MemberSignature Language="DocId" Value="P:Android.AdServices.Signals.ProtectedSignalsManager.ThresholdClass" />
      <MemberSignature Language="F#" Value="member this.ThresholdClass : nativeint" Usage="Android.AdServices.Signals.ProtectedSignalsManager.ThresholdClass" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Mono.Android</AssemblyName>
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
          <AttributeName Language="F#">[&lt;System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)&gt;]</AttributeName>
        </Attribute>
        <Attribute>
          <AttributeName Language="C#">[System.Diagnostics.DebuggerBrowsable(System.Diagnostics.DebuggerBrowsableState.Never)]</AttributeName>
          <AttributeName Language="F#">[&lt;System.Diagnostics.DebuggerBrowsable(System.Diagnostics.DebuggerBrowsableState.Never)&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.IntPtr</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>To be added.</summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ThresholdType">
      <MemberSignature Language="C#" Value="protected override Type ThresholdType { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.Type ThresholdType" />
      <MemberSignature Language="DocId" Value="P:Android.AdServices.Signals.ProtectedSignalsManager.ThresholdType" />
      <MemberSignature Language="F#" Value="member this.ThresholdType : Type" Usage="Android.AdServices.Signals.ProtectedSignalsManager.ThresholdType" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Mono.Android</AssemblyName>
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
          <AttributeName Language="F#">[&lt;System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)&gt;]</AttributeName>
        </Attribute>
        <Attribute>
          <AttributeName Language="C#">[System.Diagnostics.DebuggerBrowsable(System.Diagnostics.DebuggerBrowsableState.Never)]</AttributeName>
          <AttributeName Language="F#">[&lt;System.Diagnostics.DebuggerBrowsable(System.Diagnostics.DebuggerBrowsableState.Never)&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Type</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>To be added.</summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="UpdateSignals">
      <MemberSignature Language="C#" Value="public virtual void UpdateSignals (Android.AdServices.Signals.UpdateSignalsRequest updateSignalsRequest, Java.Util.Concurrent.IExecutor executor, Android.OS.IOutcomeReceiver receiver);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void UpdateSignals(class Android.AdServices.Signals.UpdateSignalsRequest updateSignalsRequest, class Java.Util.Concurrent.IExecutor executor, class Android.OS.IOutcomeReceiver receiver) cil managed" />
      <MemberSignature Language="DocId" Value="M:Android.AdServices.Signals.ProtectedSignalsManager.UpdateSignals(Android.AdServices.Signals.UpdateSignalsRequest,Java.Util.Concurrent.IExecutor,Android.OS.IOutcomeReceiver)" />
      <MemberSignature Language="F#" Value="abstract member UpdateSignals : Android.AdServices.Signals.UpdateSignalsRequest * Java.Util.Concurrent.IExecutor * Android.OS.IOutcomeReceiver -&gt; unit&#xA;override this.UpdateSignals : Android.AdServices.Signals.UpdateSignalsRequest * Java.Util.Concurrent.IExecutor * Android.OS.IOutcomeReceiver -&gt; unit" Usage="protectedSignalsManager.UpdateSignals (updateSignalsRequest, executor, receiver)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Mono.Android</AssemblyName>
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[Android.Runtime.Register("updateSignals", "(Landroid/adservices/signals/UpdateSignalsRequest;Ljava/util/concurrent/Executor;Landroid/os/OutcomeReceiver;)V", "GetUpdateSignals_Landroid_adservices_signals_UpdateSignalsRequest_Ljava_util_concurrent_Executor_Landroid_os_OutcomeReceiver_Handler", ApiSince=35)]</AttributeName>
          <AttributeName Language="F#">[&lt;Android.Runtime.Register("updateSignals", "(Landroid/adservices/signals/UpdateSignalsRequest;Ljava/util/concurrent/Executor;Landroid/os/OutcomeReceiver;)V", "GetUpdateSignals_Landroid_adservices_signals_UpdateSignalsRequest_Ljava_util_concurrent_Executor_Landroid_os_OutcomeReceiver_Handler", ApiSince=35)&gt;]</AttributeName>
        </Attribute>
        <Attribute>
          <AttributeName Language="C#">[Android.Runtime.RequiresPermission("android.permission.ACCESS_ADSERVICES_PROTECTED_SIGNALS")]</AttributeName>
          <AttributeName Language="F#">[&lt;Android.Runtime.RequiresPermission("android.permission.ACCESS_ADSERVICES_PROTECTED_SIGNALS")&gt;]</AttributeName>
        </Attribute>
        <Attribute>
          <AttributeName Language="C#">[System.Runtime.Versioning.SupportedOSPlatform("android35.0")]</AttributeName>
          <AttributeName Language="F#">[&lt;System.Runtime.Versioning.SupportedOSPlatform("android35.0")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="updateSignalsRequest" Type="Android.AdServices.Signals.UpdateSignalsRequest" />
        <Parameter Name="executor" Type="Java.Util.Concurrent.IExecutor" />
        <Parameter Name="receiver" Type="Android.OS.IOutcomeReceiver" />
      </Parameters>
      <Docs>
        <param name="updateSignalsRequest">To be added.</param>
        <param name="executor">To be added.</param>
        <param name="receiver">To be added.</param>
        <summary>The updateSignals API will retrieve a JSON from the URI that describes which signals to add
            or remove.</summary>
        <remarks>
          <para>The updateSignals API will retrieve a JSON from the URI that describes which signals to add
            or remove. This API also allows registering the encoder endpoint. The endpoint is used to
            download an encoding logic, which enables encoding the signals.</para>
          <para>The top level keys for the JSON must correspond to one of 5 commands:</para>
          <para>"put" - Adds a new signal, overwriting any existing signals with the same key. The value
            for this is a JSON object where the keys are base 64 strings corresponding to the key to put
            for and the values are base 64 string corresponding to the value to put.</para>
          <para>"append" - Appends a new signal/signals to a time series of signals, removing the oldest
            signals to make room for the new ones if the size of the series exceeds the given maximum.
            The value for this is a JSON object where the keys are base 64 strings corresponding to the
            key to append to and the values are objects with two fields: "values" and "maxSignals" .
            "values" is a list of base 64 strings corresponding to signal values to append to the time
            series. "maxSignals" is the maximum number of values that are allowed in this timeseries. If
            the current number of signals associated with the key exceeds maxSignals the oldest signals
            will be removed. Note that you can append to a key added by put. Not that appending more than
            the maximum number of values will cause a failure.</para>
          <para>"put_if_not_present" - Adds a new signal only if there are no existing signals with the
            same key. The value for this is a JSON object where the keys are base 64 strings
            corresponding to the key to put for and the values are base 64 string corresponding to the
            value to put.</para>
          <para>"remove" - Removes the signal for a key. The value of this is a list of base 64 strings
            corresponding to the keys of signals that should be deleted.</para>
          <para>"update_encoder" - Provides an action to update the endpoint, and a URI which can be used
            to retrieve an encoding logic. The sub-key for providing an update action is "action" and the
            values currently supported are:
            
            &lt;ol&gt;
              &lt;li&gt;"REGISTER" : Registers the encoder endpoint if provided for the first time or
                  overwrites the existing one with the newly provided endpoint. Providing the "endpoint"
                  is required for the "REGISTER" action.
            &lt;/ol&gt;</para>
          <para>The sub-key for providing an encoder endpoint is "endpoint" and the value is the URI
            string for the endpoint.</para>
          <para>On success, the onResult method of the provided OutcomeReceiver will be called with an
            empty Object. This Object has no significance and is used merely as a placeholder.</para>
          <para>Key may only be operated on by one command per JSON. If two command attempt to operate on
            the same key, this method will through an <c>IllegalArgumentException</c></para>
          <para>This call fails with an <c>SecurityException</c> if
            
            &lt;ol&gt;
              &lt;li&gt;the <c>ownerPackageName</c> is not calling app's package name and/or
              &lt;li&gt;the buyer is not authorized to use the API.
            &lt;/ol&gt;</para>
          <para>This call fails with an <c>IllegalArgumentException</c> if
            
            &lt;ol&gt;
              &lt;li&gt;The JSON retrieved from the server is not valid.
              &lt;li&gt;The provided URI is invalid.
            &lt;/ol&gt;</para>
          <para>This call fails with <c>LimitExceededException</c> if the calling package exceeds the
            allowed rate limits and is throttled.</para>
          <para>This call fails with an <c>IllegalStateException</c> if an internal service error is
            encountered.</para>
          <para>
            <format type="text/html">
              <a href="https://developer.android.com/reference/android/adservices/signals/ProtectedSignalsManager#updateSignals(android.adservices.signals.UpdateSignalsRequest,%20java.util.concurrent.Executor,%20android.os.OutcomeReceiver%3Cjava.lang.Object,%20java.lang.Exception%3E)" title="Reference documentation">Java documentation for <code>android.adservices.signals.ProtectedSignalsManager.updateSignals(android.adservices.signals.UpdateSignalsRequest, java.util.concurrent.Executor, android.os.OutcomeReceiver&lt;java.lang.Object, java.lang.Exception&gt;)</code>.</a>
            </format>
          </para>
          <para>
                    Portions of this page are modifications based on work created and shared by the 
                    <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
                     and used according to terms described in the 
                    <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
        </remarks>
      </Docs>
    </Member>
  </Members>
</Type>