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 |
Marks an album as 'shared' and accessible to other users. This action can only be performed on albums which were created by the developer via the API.
See: Photos Library API Reference for photoslibrary.albums.share
.
Synopsis
- type AlbumsShareResource = "v1" :> ("albums" :> (CaptureMode "albumId" "share" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "pp" Bool :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "bearer_token" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] ShareAlbumRequest :> Post '[JSON] ShareAlbumResponse)))))))))))
- albumsShare :: Text -> ShareAlbumRequest -> AlbumsShare
- data AlbumsShare
- asXgafv :: Lens' AlbumsShare (Maybe Xgafv)
- asAlbumId :: Lens' AlbumsShare Text
- asUploadProtocol :: Lens' AlbumsShare (Maybe Text)
- asPp :: Lens' AlbumsShare Bool
- asAccessToken :: Lens' AlbumsShare (Maybe Text)
- asUploadType :: Lens' AlbumsShare (Maybe Text)
- asPayload :: Lens' AlbumsShare ShareAlbumRequest
- asBearerToken :: Lens' AlbumsShare (Maybe Text)
- asCallback :: Lens' AlbumsShare (Maybe Text)
REST Resource
type AlbumsShareResource = "v1" :> ("albums" :> (CaptureMode "albumId" "share" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "pp" Bool :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "bearer_token" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] ShareAlbumRequest :> Post '[JSON] ShareAlbumResponse))))))))))) Source #
A resource alias for photoslibrary.albums.share
method which the
AlbumsShare
request conforms to.
Creating a Request
Creates a value of AlbumsShare
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data AlbumsShare Source #
Marks an album as 'shared' and accessible to other users. This action can only be performed on albums which were created by the developer via the API.
See: albumsShare
smart constructor.
Request Lenses
asAlbumId :: Lens' AlbumsShare Text Source #
Identifier of the album to be shared. This album id must belong to an album created by the developer. .
asUploadProtocol :: Lens' AlbumsShare (Maybe Text) Source #
Upload protocol for media (e.g. "raw", "multipart").
asAccessToken :: Lens' AlbumsShare (Maybe Text) Source #
OAuth access token.
asUploadType :: Lens' AlbumsShare (Maybe Text) Source #
Legacy upload protocol for media (e.g. "media", "multipart").
asPayload :: Lens' AlbumsShare ShareAlbumRequest Source #
Multipart request metadata.
asBearerToken :: Lens' AlbumsShare (Maybe Text) Source #
OAuth bearer token.
asCallback :: Lens' AlbumsShare (Maybe Text) Source #
JSONP