Copyright | (c) 2015-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Retrieves a list of all statements from a given source that match the specified target and statement string. The API guarantees that all statements with secure source assets, such as HTTPS websites or Android apps, have been made in a secure way by the owner of those assets, as described in the Digital Asset Links technical design specification. Specifically, you should consider that for insecure websites (that is, where the URL starts with `http://` instead of `https://`), this guarantee cannot be made. The `List` command is most useful in cases where the API client wants to know all the ways in which two assets are related, or enumerate all the relationships from a particular source asset. Example: a feature that helps users navigate to related items. When a mobile app is running on a device, the feature would make it easy to navigate to the corresponding web site or Google+ profile.
See: Digital Asset Links API Reference for digitalassetlinks.statements.list
.
Synopsis
- type StatementsListResource = "v1" :> ("statements:list" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "source.androidApp.certificate.sha256Fingerprint" Text :> (QueryParam "source.androidApp.packageName" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "relation" Text :> (QueryParam "source.web.site" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] ListResponse)))))))))))
- statementsList :: StatementsList
- data StatementsList
- slXgafv :: Lens' StatementsList (Maybe Xgafv)
- slSourceAndroidAppCertificateSha256Fingerprint :: Lens' StatementsList (Maybe Text)
- slSourceAndroidAppPackageName :: Lens' StatementsList (Maybe Text)
- slUploadProtocol :: Lens' StatementsList (Maybe Text)
- slAccessToken :: Lens' StatementsList (Maybe Text)
- slUploadType :: Lens' StatementsList (Maybe Text)
- slRelation :: Lens' StatementsList (Maybe Text)
- slSourceWebSite :: Lens' StatementsList (Maybe Text)
- slCallback :: Lens' StatementsList (Maybe Text)
REST Resource
type StatementsListResource = "v1" :> ("statements:list" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "source.androidApp.certificate.sha256Fingerprint" Text :> (QueryParam "source.androidApp.packageName" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "relation" Text :> (QueryParam "source.web.site" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] ListResponse))))))))))) Source #
A resource alias for digitalassetlinks.statements.list
method which the
StatementsList
request conforms to.
Creating a Request
statementsList :: StatementsList Source #
Creates a value of StatementsList
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data StatementsList Source #
Retrieves a list of all statements from a given source that match the specified target and statement string. The API guarantees that all statements with secure source assets, such as HTTPS websites or Android apps, have been made in a secure way by the owner of those assets, as described in the Digital Asset Links technical design specification. Specifically, you should consider that for insecure websites (that is, where the URL starts with `http://` instead of `https://`), this guarantee cannot be made. The `List` command is most useful in cases where the API client wants to know all the ways in which two assets are related, or enumerate all the relationships from a particular source asset. Example: a feature that helps users navigate to related items. When a mobile app is running on a device, the feature would make it easy to navigate to the corresponding web site or Google+ profile.
See: statementsList
smart constructor.
Instances
Request Lenses
slSourceAndroidAppPackageName :: Lens' StatementsList (Maybe Text) Source #
Android App assets are naturally identified by their Java package name. For example, the Google Maps app uses the package name `com.google.android.apps.maps`. REQUIRED
slUploadProtocol :: Lens' StatementsList (Maybe Text) Source #
Upload protocol for media (e.g. "raw", "multipart").
slAccessToken :: Lens' StatementsList (Maybe Text) Source #
OAuth access token.
slUploadType :: Lens' StatementsList (Maybe Text) Source #
Legacy upload protocol for media (e.g. "media", "multipart").
slRelation :: Lens' StatementsList (Maybe Text) Source #
Use only associations that match the specified relation. See the `Statement` message for a detailed definition of relation strings. For a query to match a statement, one of the following must be true: * both the query's and the statement's relation strings match exactly, or * the query's relation string is empty or missing. Example: A query with relation `delegate_permission/common.handle_all_urls` matches an asset link with relation `delegate_permission/common.handle_all_urls`.
slSourceWebSite :: Lens' StatementsList (Maybe Text) Source #
Web assets are identified by a URL that contains only the scheme, hostname and port parts. The format is http[s]://[:] Hostnames must be fully qualified: they must end in a single period ("`.`"). Only the schemes "http" and "https" are currently allowed. Port numbers are given as a decimal number, and they must be omitted if the standard port numbers are used: 80 for http and 443 for https. We call this limited URL the "site". All URLs that share the same scheme, hostname and port are considered to be a part of the site and thus belong to the web asset. Example: the asset with the site `https://www.google.com` contains all these URLs: * `https://www.google.com/` * `https://www.google.com:443/` * `https://www.google.com/foo` * `https://www.google.com/foo?bar` * `https://www.google.com/foo#bar` * `https://user'password:www.google.com/` But it does not contain these URLs: * `http://www.google.com/` (wrong scheme) * `https://google.com/` (hostname does not match) * `https://www.google.com:444/` (port does not match) REQUIRED
slCallback :: Lens' StatementsList (Maybe Text) Source #
JSONP