mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-27 04:10:02 +01:00
423 lines
22 KiB
HTML
423 lines
22 KiB
HTML
<!DOCTYPE html>
|
|
<html class="writer-html5" lang="en" >
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><link rel="canonical" href="http://byron.github.io/google-apis-rs/google-androidenterprise1-cli/enterprises_pull-notification-set/" />
|
|
<link rel="shortcut icon" href="../img/favicon.ico" />
|
|
<title>Pull Notification Set - Android Enterprise v5.0.4+20240304</title>
|
|
<link rel="stylesheet" href="../css/theme.css" />
|
|
<link rel="stylesheet" href="../css/theme_extra.css" />
|
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
|
|
|
|
<script>
|
|
// Current page data
|
|
var mkdocs_page_name = "Pull Notification Set";
|
|
var mkdocs_page_input_path = "enterprises_pull-notification-set.md";
|
|
var mkdocs_page_url = "/google-apis-rs/google-androidenterprise1-cli/enterprises_pull-notification-set/";
|
|
</script>
|
|
|
|
<script src="../js/jquery-3.6.0.min.js" defer></script>
|
|
<!--[if lt IE 9]>
|
|
<script src="../js/html5shiv.min.js"></script>
|
|
<![endif]-->
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
|
|
<script>hljs.initHighlightingOnLoad();</script>
|
|
</head>
|
|
|
|
<body class="wy-body-for-nav" role="document">
|
|
|
|
<div class="wy-grid-for-nav">
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
|
<div class="wy-side-scroll">
|
|
<div class="wy-side-nav-search">
|
|
<a href=".." class="icon icon-home"> Android Enterprise v5.0.4+20240304
|
|
</a><div role="search">
|
|
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
|
|
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
|
|
</form>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="..">Home</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Devices</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../devices_force-report-upload/">Force Report Upload</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../devices_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../devices_get-state/">Get State</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../devices_list/">List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../devices_set-state/">Set State</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../devices_update/">Update</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Enterprises</span></p>
|
|
<ul class="current">
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_acknowledge-notification-set/">Acknowledge Notification Set</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_complete-signup/">Complete Signup</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_create-enrollment-token/">Create Enrollment Token</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_create-web-token/">Create Web Token</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_enroll/">Enroll</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_generate-signup-url/">Generate Signup Url</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_get-service-account/">Get Service Account</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_get-store-layout/">Get Store Layout</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_list/">List</a>
|
|
</li>
|
|
<li class="toctree-l1 current"><a class="reference internal current" href="./">Pull Notification Set</a>
|
|
<ul class="current">
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_send-test-push-notification/">Send Test Push Notification</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_set-account/">Set Account</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_set-store-layout/">Set Store Layout</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_unenroll/">Unenroll</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Entitlements</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../entitlements_delete/">Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../entitlements_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../entitlements_list/">List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../entitlements_update/">Update</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Grouplicenses</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../grouplicenses_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../grouplicenses_list/">List</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Grouplicenseusers</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../grouplicenseusers_list/">List</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Installs</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../installs_delete/">Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../installs_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../installs_list/">List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../installs_update/">Update</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Managedconfigurationsfordevice</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../managedconfigurationsfordevice_delete/">Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../managedconfigurationsfordevice_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../managedconfigurationsfordevice_list/">List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../managedconfigurationsfordevice_update/">Update</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Managedconfigurationsforuser</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../managedconfigurationsforuser_delete/">Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../managedconfigurationsforuser_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../managedconfigurationsforuser_list/">List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../managedconfigurationsforuser_update/">Update</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Managedconfigurationssettings</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../managedconfigurationssettings_list/">List</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Permissions</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../permissions_get/">Get</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Products</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../products_approve/">Approve</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../products_generate-approval-url/">Generate Approval Url</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../products_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../products_get-app-restrictions-schema/">Get App Restrictions Schema</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../products_get-permissions/">Get Permissions</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../products_list/">List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../products_unapprove/">Unapprove</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Serviceaccountkeys</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../serviceaccountkeys_delete/">Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../serviceaccountkeys_insert/">Insert</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../serviceaccountkeys_list/">List</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Storelayoutclusters</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../storelayoutclusters_delete/">Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../storelayoutclusters_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../storelayoutclusters_insert/">Insert</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../storelayoutclusters_list/">List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../storelayoutclusters_update/">Update</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Storelayoutpages</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../storelayoutpages_delete/">Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../storelayoutpages_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../storelayoutpages_insert/">Insert</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../storelayoutpages_list/">List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../storelayoutpages_update/">Update</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Users</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../users_delete/">Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../users_generate-authentication-token/">Generate Authentication Token</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../users_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../users_get-available-product-set/">Get Available Product Set</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../users_insert/">Insert</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../users_list/">List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../users_revoke-device-access/">Revoke Device Access</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../users_set-available-product-set/">Set Available Product Set</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../users_update/">Update</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Webapps</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../webapps_delete/">Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../webapps_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../webapps_insert/">Insert</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../webapps_list/">List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../webapps_update/">Update</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
<a href="..">Android Enterprise v5.0.4+20240304</a>
|
|
|
|
</nav>
|
|
<div class="wy-nav-content">
|
|
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
|
|
<ul class="wy-breadcrumbs">
|
|
<li><a href=".." class="icon icon-home" alt="Docs"></a> »</li>
|
|
<li>Enterprises »</li>
|
|
<li>Pull Notification Set</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/androidenterprise1-cli/edit/master/docs/enterprises_pull-notification-set.md"
|
|
class="icon icon-github"> Edit on GitHub</a>
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|
<div class="section" itemprop="articleBody">
|
|
|
|
<p>Pulls and returns a notification set for the enterprises associated with the service account authenticated for the request. The notification set may be empty if no notification are pending. A notification set returned needs to be acknowledged within 20 seconds by calling Enterprises.AcknowledgeNotificationSet, unless the notification set is empty. Notifications that are not acknowledged within the 20 seconds will eventually be included again in the response to another PullNotificationSet request, and those that are never acknowledged will ultimately be deleted according to the Google Cloud Platform Pub/Sub system policy. Multiple requests might be performed concurrently to retrieve notifications, in which case the pending notifications (if any) will be split among each caller, if any are pending. If no notifications are present, an empty notification list is returned. Subsequent requests may return more notifications once they become available.</p>
|
|
<h1 id="scopes">Scopes</h1>
|
|
<p>You will need authorization for the <em>https://www.googleapis.com/auth/androidenterprise</em> scope to make a valid call.</p>
|
|
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/androidenterprise</em>.
|
|
You can set the scope for this method like this: <code>androidenterprise1 --scope <scope> enterprises pull-notification-set ...</code></p>
|
|
<h1 id="optional-output-flags">Optional Output Flags</h1>
|
|
<p>The method's return value a JSON encoded structure, which will be written to standard output by default.</p>
|
|
<ul>
|
|
<li><strong>-o out</strong><ul>
|
|
<li><em>out</em> specifies the <em>destination</em> to which to write the server's result to.
|
|
It will be a JSON-encoded structure.
|
|
The <em>destination</em> may be <code>-</code> to indicate standard output, or a filepath that is to contain the received bytes.
|
|
If unset, it defaults to standard output.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h1 id="optional-method-properties">Optional Method Properties</h1>
|
|
<p>You may set the following properties to further configure the call. Please note that <code>-p</code> is followed by one
|
|
or more key-value-pairs, and is called like this <code>-p k1=v1 k2=v2</code> even though the listing below repeats the
|
|
<code>-p</code> for completeness.</p>
|
|
<ul>
|
|
<li><strong>-p request-mode=string</strong><ul>
|
|
<li>The request mode for pulling notifications. Specifying waitForNotifications will cause the request to block and wait until one or more notifications are present, or return an empty notification list if no notifications are present after some time. Specifying returnImmediately will cause the request to immediately return the pending notifications, or an empty list if no notifications are present. If omitted, defaults to waitForNotifications.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h1 id="optional-general-properties">Optional General Properties</h1>
|
|
<p>The following properties can configure any call, and are not specific to this method.</p>
|
|
<ul>
|
|
<li>
|
|
<p><strong>-p $-xgafv=string</strong></p>
|
|
<ul>
|
|
<li>V1 error format.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p access-token=string</strong></p>
|
|
<ul>
|
|
<li>OAuth access token.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p alt=string</strong></p>
|
|
<ul>
|
|
<li>Data format for response.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p callback=string</strong></p>
|
|
<ul>
|
|
<li>JSONP</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p fields=string</strong></p>
|
|
<ul>
|
|
<li>Selector specifying which fields to include in a partial response.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p key=string</strong></p>
|
|
<ul>
|
|
<li>API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p oauth-token=string</strong></p>
|
|
<ul>
|
|
<li>OAuth 2.0 token for the current user.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p pretty-print=boolean</strong></p>
|
|
<ul>
|
|
<li>Returns response with indentations and line breaks.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p quota-user=string</strong></p>
|
|
<ul>
|
|
<li>Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p upload-type=string</strong></p>
|
|
<ul>
|
|
<li>Legacy upload protocol for media (e.g. "media", "multipart").</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p upload-protocol=string</strong></p>
|
|
<ul>
|
|
<li>Upload protocol for media (e.g. "raw", "multipart").</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div><footer>
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
|
|
<a href="../enterprises_list/" class="btn btn-neutral float-left" title="List"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
<a href="../enterprises_send-test-push-notification/" class="btn btn-neutral float-right" title="Send Test Push Notification">Next <span class="icon icon-circle-arrow-right"></span></a>
|
|
</div>
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<!-- Copyright etc -->
|
|
<p>Copyright © 2015-2020, `Sebastian Thiel`</p>
|
|
</div>
|
|
|
|
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|
</footer>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</section>
|
|
|
|
</div>
|
|
|
|
<div class="rst-versions" role="note" aria-label="Versions">
|
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
|
|
|
<span>
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/androidenterprise1-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
|
</span>
|
|
|
|
|
|
<span><a href="../enterprises_list/" style="color: #fcfcfc">« Previous</a></span>
|
|
|
|
|
|
<span><a href="../enterprises_send-test-push-notification/" style="color: #fcfcfc">Next »</a></span>
|
|
|
|
</span>
|
|
</div>
|
|
<script>var base_url = '..';</script>
|
|
<script src="../js/theme_extra.js" defer></script>
|
|
<script src="../js/theme.js" defer></script>
|
|
<script src="../search/main.js" defer></script>
|
|
<script defer>
|
|
window.onload = function () {
|
|
SphinxRtdTheme.Navigation.enable(true);
|
|
};
|
|
</script>
|
|
|
|
</body>
|
|
</html>
|