Package com.google.photos.types.proto

Interface AlbumOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Album, Album.Builder
    public interface AlbumOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getCoverPhotoBaseUrl()
      [Output only] A URL to the cover photo's bytes.
      com.google.protobuf.ByteString getCoverPhotoBaseUrlBytes()
      [Output only] A URL to the cover photo's bytes.
      java.lang.String getCoverPhotoMediaItemId()
      Identifier for the media item associated with the cover photo.
      com.google.protobuf.ByteString getCoverPhotoMediaItemIdBytes()
      Identifier for the media item associated with the cover photo.
      java.lang.String getId()
      Identifier for the album.
      com.google.protobuf.ByteString getIdBytes()
      Identifier for the album.
      boolean getIsWriteable()
      [Output only] True if you can create media items in this album.
      long getMediaItemsCount()
      [Output only] The number of media items in the album.
      java.lang.String getProductUrl()
      [Output only] Google Photos URL for the album.
      com.google.protobuf.ByteString getProductUrlBytes()
      [Output only] Google Photos URL for the album.
      ShareInfo getShareInfo()
      [Output only] Information related to shared albums.
      ShareInfoOrBuilder getShareInfoOrBuilder()
      [Output only] Information related to shared albums.
      java.lang.String getTitle()
      Name of the album displayed to the user in their Google Photos account.
      com.google.protobuf.ByteString getTitleBytes()
      Name of the album displayed to the user in their Google Photos account.
      boolean hasShareInfo()
      [Output only] Information related to shared albums.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • getId

        java.lang.String getId()
         Identifier for the album. This is a persistent identifier that
 can be used between sessions to identify this album.
        string id = 1;
        Returns:
        The id.

      • getIdBytes

        com.google.protobuf.ByteString getIdBytes()
         Identifier for the album. This is a persistent identifier that
 can be used between sessions to identify this album.
        string id = 1;
        Returns:
        The bytes for id.

      • getTitle

        java.lang.String getTitle()
         Name of the album displayed to the user in their Google Photos account.
 This string shouldn't be more than 500 characters.
        string title = 2;
        Returns:
        The title.

      • getTitleBytes

        com.google.protobuf.ByteString getTitleBytes()
         Name of the album displayed to the user in their Google Photos account.
 This string shouldn't be more than 500 characters.
        string title = 2;
        Returns:
        The bytes for title.

      • getProductUrl

        java.lang.String getProductUrl()
         [Output only] Google Photos URL for the album. The user needs to be signed
 in to their Google Photos account to access this link.
        string product_url = 3;
        Returns:
        The productUrl.

      • getProductUrlBytes

        com.google.protobuf.ByteString getProductUrlBytes()
         [Output only] Google Photos URL for the album. The user needs to be signed
 in to their Google Photos account to access this link.
        string product_url = 3;
        Returns:
        The bytes for productUrl.

      • getIsWriteable

        boolean getIsWriteable()
         [Output only] True if you can create media items in this album.
 This field is based on the scopes granted and permissions of the album. If
 the scopes are changed or permissions of the album are changed, this field
 is updated.
        bool is_writeable = 4;
        Returns:
        The isWriteable.

      • hasShareInfo

        boolean hasShareInfo()
         [Output only] Information related to shared albums.
 This field is only populated if the album is a shared album, the
 developer created the album and the user has granted the
 `photoslibrary.sharing` scope.
        .google.photos.types.ShareInfo share_info = 5;
        Returns:
        Whether the shareInfo field is set.

      • getShareInfo

        ShareInfo getShareInfo()
         [Output only] Information related to shared albums.
 This field is only populated if the album is a shared album, the
 developer created the album and the user has granted the
 `photoslibrary.sharing` scope.
        .google.photos.types.ShareInfo share_info = 5;
        Returns:
        The shareInfo.

      • getShareInfoOrBuilder

        ShareInfoOrBuilder getShareInfoOrBuilder()
         [Output only] Information related to shared albums.
 This field is only populated if the album is a shared album, the
 developer created the album and the user has granted the
 `photoslibrary.sharing` scope.
        .google.photos.types.ShareInfo share_info = 5;

      • getMediaItemsCount

        long getMediaItemsCount()
         [Output only] The number of media items in the album.
        int64 media_items_count = 6;
        Returns:
        The mediaItemsCount.

      • getCoverPhotoBaseUrl

        java.lang.String getCoverPhotoBaseUrl()
         [Output only] A URL to the cover photo's bytes. This shouldn't be used as
 is. Parameters should be appended to this URL before use. See the
 [developer
 documentation](https://developers.google.com/photos/library/guides/access-media-items#base-urls)
 for a complete list of supported parameters. For example,
 `'=w2048-h1024'` sets the dimensions of the cover photo to have a width of
 2048 px and height of 1024 px.
        string cover_photo_base_url = 7;
        Returns:
        The coverPhotoBaseUrl.

      • getCoverPhotoBaseUrlBytes

        com.google.protobuf.ByteString getCoverPhotoBaseUrlBytes()
         [Output only] A URL to the cover photo's bytes. This shouldn't be used as
 is. Parameters should be appended to this URL before use. See the
 [developer
 documentation](https://developers.google.com/photos/library/guides/access-media-items#base-urls)
 for a complete list of supported parameters. For example,
 `'=w2048-h1024'` sets the dimensions of the cover photo to have a width of
 2048 px and height of 1024 px.
        string cover_photo_base_url = 7;
        Returns:
        The bytes for coverPhotoBaseUrl.

      • getCoverPhotoMediaItemId

        java.lang.String getCoverPhotoMediaItemId()
         Identifier for the media item associated with the cover photo.
        string cover_photo_media_item_id = 8;
        Returns:
        The coverPhotoMediaItemId.

      • getCoverPhotoMediaItemIdBytes

        com.google.protobuf.ByteString getCoverPhotoMediaItemIdBytes()
         Identifier for the media item associated with the cover photo.
        string cover_photo_media_item_id = 8;
        Returns:
        The bytes for coverPhotoMediaItemId.