| 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 |
Network.Google.Mirror
Contents
- Service Configuration
- OAuth Scopes
- API Declaration
- Resources
- mirror.accounts.insert
- mirror.contacts.delete
- mirror.contacts.get
- mirror.contacts.insert
- mirror.contacts.list
- mirror.contacts.patch
- mirror.contacts.update
- mirror.locations.get
- mirror.locations.list
- mirror.settings.get
- mirror.subscriptions.delete
- mirror.subscriptions.insert
- mirror.subscriptions.list
- mirror.subscriptions.update
- mirror.timeline.attachments.delete
- mirror.timeline.attachments.get
- mirror.timeline.attachments.insert
- mirror.timeline.attachments.list
- mirror.timeline.delete
- mirror.timeline.get
- mirror.timeline.insert
- mirror.timeline.list
- mirror.timeline.patch
- mirror.timeline.update
- Types
Description
Interacts with Glass users via the timeline.
Synopsis
- mirrorService :: ServiceConfig
- glassTimelineScope :: Proxy '["https://www.googleapis.com/auth/glass.timeline"]
- glassLocationScope :: Proxy '["https://www.googleapis.com/auth/glass.location"]
- type MirrorAPI = AccountsInsertResource :<|> (SettingsGetResource :<|> (SubscriptionsInsertResource :<|> (SubscriptionsListResource :<|> (SubscriptionsDeleteResource :<|> (SubscriptionsUpdateResource :<|> (TimelineAttachmentsInsertResource :<|> (TimelineAttachmentsListResource :<|> (TimelineAttachmentsGetResource :<|> (TimelineAttachmentsDeleteResource :<|> (TimelineInsertResource :<|> (TimelineListResource :<|> (TimelinePatchResource :<|> (TimelineGetResource :<|> (TimelineDeleteResource :<|> (TimelineUpdateResource :<|> (ContactsInsertResource :<|> (ContactsListResource :<|> (ContactsPatchResource :<|> (ContactsGetResource :<|> (ContactsDeleteResource :<|> (ContactsUpdateResource :<|> (LocationsListResource :<|> LocationsGetResource))))))))))))))))))))))
- module Network.Google.Resource.Mirror.Accounts.Insert
- module Network.Google.Resource.Mirror.Contacts.Delete
- module Network.Google.Resource.Mirror.Contacts.Get
- module Network.Google.Resource.Mirror.Contacts.Insert
- module Network.Google.Resource.Mirror.Contacts.List
- module Network.Google.Resource.Mirror.Contacts.Patch
- module Network.Google.Resource.Mirror.Contacts.Update
- module Network.Google.Resource.Mirror.Locations.Get
- module Network.Google.Resource.Mirror.Locations.List
- module Network.Google.Resource.Mirror.Settings.Get
- module Network.Google.Resource.Mirror.Subscriptions.Delete
- module Network.Google.Resource.Mirror.Subscriptions.Insert
- module Network.Google.Resource.Mirror.Subscriptions.List
- module Network.Google.Resource.Mirror.Subscriptions.Update
- module Network.Google.Resource.Mirror.Timeline.Attachments.Delete
- module Network.Google.Resource.Mirror.Timeline.Attachments.Get
- module Network.Google.Resource.Mirror.Timeline.Attachments.Insert
- module Network.Google.Resource.Mirror.Timeline.Attachments.List
- module Network.Google.Resource.Mirror.Timeline.Delete
- module Network.Google.Resource.Mirror.Timeline.Get
- module Network.Google.Resource.Mirror.Timeline.Insert
- module Network.Google.Resource.Mirror.Timeline.List
- module Network.Google.Resource.Mirror.Timeline.Patch
- module Network.Google.Resource.Mirror.Timeline.Update
- data TimelineListOrderBy
- data NotificationConfig
- notificationConfig :: NotificationConfig
- ncDeliveryTime :: Lens' NotificationConfig (Maybe UTCTime)
- ncLevel :: Lens' NotificationConfig (Maybe Text)
- data Command
- command :: Command
- cType :: Lens' Command (Maybe Text)
- data LocationsListResponse
- locationsListResponse :: LocationsListResponse
- llrKind :: Lens' LocationsListResponse Text
- llrItems :: Lens' LocationsListResponse [Location]
- data Location
- location :: Location
- lKind :: Lens' Location Text
- lLatitude :: Lens' Location (Maybe Double)
- lAddress :: Lens' Location (Maybe Text)
- lDisplayName :: Lens' Location (Maybe Text)
- lId :: Lens' Location (Maybe Text)
- lAccuracy :: Lens' Location (Maybe Double)
- lLongitude :: Lens' Location (Maybe Double)
- lTimestamp :: Lens' Location (Maybe UTCTime)
- data Notification
- notification :: Notification
- nOperation :: Lens' Notification (Maybe Text)
- nItemId :: Lens' Notification (Maybe Text)
- nCollection :: Lens' Notification (Maybe Text)
- nUserActions :: Lens' Notification [UserAction]
- nVerifyToken :: Lens' Notification (Maybe Text)
- nUserToken :: Lens' Notification (Maybe Text)
- data Contact
- contact :: Contact
- conAcceptCommands :: Lens' Contact [Command]
- conSharingFeatures :: Lens' Contact [Text]
- conImageURLs :: Lens' Contact [Text]
- conPriority :: Lens' Contact (Maybe Word32)
- conKind :: Lens' Contact Text
- conAcceptTypes :: Lens' Contact [Text]
- conPhoneNumber :: Lens' Contact (Maybe Text)
- conDisplayName :: Lens' Contact (Maybe Text)
- conSource :: Lens' Contact (Maybe Text)
- conId :: Lens' Contact (Maybe Text)
- conType :: Lens' Contact (Maybe Text)
- conSpeakableName :: Lens' Contact (Maybe Text)
- data AuthToken
- authToken :: AuthToken
- atAuthToken :: Lens' AuthToken (Maybe Text)
- atType :: Lens' AuthToken (Maybe Text)
- data AttachmentsListResponse
- attachmentsListResponse :: AttachmentsListResponse
- alrKind :: Lens' AttachmentsListResponse Text
- alrItems :: Lens' AttachmentsListResponse [Attachment]
- data MenuItem
- menuItem :: MenuItem
- miValues :: Lens' MenuItem [MenuValue]
- miRemoveWhenSelected :: Lens' MenuItem (Maybe Bool)
- miAction :: Lens' MenuItem (Maybe Text)
- miPayload :: Lens' MenuItem (Maybe Text)
- miContextualCommand :: Lens' MenuItem (Maybe Text)
- miId :: Lens' MenuItem (Maybe Text)
- data Setting
- setting :: Setting
- sKind :: Lens' Setting Text
- sValue :: Lens' Setting (Maybe Text)
- sId :: Lens' Setting (Maybe Text)
- data Attachment
- attachment :: Attachment
- aContentURL :: Lens' Attachment (Maybe Text)
- aId :: Lens' Attachment (Maybe Text)
- aIsProcessingContent :: Lens' Attachment (Maybe Bool)
- aContentType :: Lens' Attachment (Maybe Text)
- data Account
- account :: Account
- aAuthTokens :: Lens' Account [AuthToken]
- aUserData :: Lens' Account [UserData]
- aPassword :: Lens' Account (Maybe Text)
- aFeatures :: Lens' Account [Text]
- data UserData
- userData :: UserData
- udValue :: Lens' UserData (Maybe Text)
- udKey :: Lens' UserData (Maybe Text)
- data UserAction
- userAction :: UserAction
- uaPayload :: Lens' UserAction (Maybe Text)
- uaType :: Lens' UserAction (Maybe Text)
- data TimelineListResponse
- timelineListResponse :: TimelineListResponse
- tlrNextPageToken :: Lens' TimelineListResponse (Maybe Text)
- tlrKind :: Lens' TimelineListResponse Text
- tlrItems :: Lens' TimelineListResponse [TimelineItem]
- data ContactsListResponse
- contactsListResponse :: ContactsListResponse
- clrKind :: Lens' ContactsListResponse Text
- clrItems :: Lens' ContactsListResponse [Contact]
- data MenuValue
- menuValue :: MenuValue
- mvState :: Lens' MenuValue (Maybe Text)
- mvDisplayName :: Lens' MenuValue (Maybe Text)
- mvIconURL :: Lens' MenuValue (Maybe Text)
- data Subscription
- subscription :: Subscription
- subCallbackURL :: Lens' Subscription (Maybe Text)
- subOperation :: Lens' Subscription [Text]
- subNotification :: Lens' Subscription (Maybe Notification)
- subKind :: Lens' Subscription Text
- subCollection :: Lens' Subscription (Maybe Text)
- subVerifyToken :: Lens' Subscription (Maybe Text)
- subUserToken :: Lens' Subscription (Maybe Text)
- subId :: Lens' Subscription (Maybe Text)
- subUpdated :: Lens' Subscription (Maybe UTCTime)
- data TimelineItem
- timelineItem :: TimelineItem
- tiCreator :: Lens' TimelineItem (Maybe Contact)
- tiDisplayTime :: Lens' TimelineItem (Maybe UTCTime)
- tiEtag :: Lens' TimelineItem (Maybe Text)
- tiIsDeleted :: Lens' TimelineItem (Maybe Bool)
- tiPinScore :: Lens' TimelineItem (Maybe Int32)
- tiAttachments :: Lens' TimelineItem [Attachment]
- tiLocation :: Lens' TimelineItem (Maybe Location)
- tiMenuItems :: Lens' TimelineItem [MenuItem]
- tiNotification :: Lens' TimelineItem (Maybe NotificationConfig)
- tiText :: Lens' TimelineItem (Maybe Text)
- tiKind :: Lens' TimelineItem Text
- tiCreated :: Lens' TimelineItem (Maybe UTCTime)
- tiSpeakableText :: Lens' TimelineItem (Maybe Text)
- tiIsBundleCover :: Lens' TimelineItem (Maybe Bool)
- tiSpeakableType :: Lens' TimelineItem (Maybe Text)
- tiBundleId :: Lens' TimelineItem (Maybe Text)
- tiCanonicalURL :: Lens' TimelineItem (Maybe Text)
- tiSelfLink :: Lens' TimelineItem (Maybe Text)
- tiIsPinned :: Lens' TimelineItem (Maybe Bool)
- tiSourceItemId :: Lens' TimelineItem (Maybe Text)
- tiId :: Lens' TimelineItem (Maybe Text)
- tiHTML :: Lens' TimelineItem (Maybe Text)
- tiUpdated :: Lens' TimelineItem (Maybe UTCTime)
- tiRecipients :: Lens' TimelineItem [Contact]
- tiTitle :: Lens' TimelineItem (Maybe Text)
- tiInReplyTo :: Lens' TimelineItem (Maybe Text)
- data SubscriptionsListResponse
- subscriptionsListResponse :: SubscriptionsListResponse
- slrKind :: Lens' SubscriptionsListResponse Text
- slrItems :: Lens' SubscriptionsListResponse [Subscription]
Service Configuration
mirrorService :: ServiceConfig Source #
Default request referring to version v1 of the Google Mirror API. This contains the host and root path used as a starting point for constructing service requests.
OAuth Scopes
glassTimelineScope :: Proxy '["https://www.googleapis.com/auth/glass.timeline"] Source #
View and manage your Glass timeline
glassLocationScope :: Proxy '["https://www.googleapis.com/auth/glass.location"] Source #
View your location
API Declaration
type MirrorAPI = AccountsInsertResource :<|> (SettingsGetResource :<|> (SubscriptionsInsertResource :<|> (SubscriptionsListResource :<|> (SubscriptionsDeleteResource :<|> (SubscriptionsUpdateResource :<|> (TimelineAttachmentsInsertResource :<|> (TimelineAttachmentsListResource :<|> (TimelineAttachmentsGetResource :<|> (TimelineAttachmentsDeleteResource :<|> (TimelineInsertResource :<|> (TimelineListResource :<|> (TimelinePatchResource :<|> (TimelineGetResource :<|> (TimelineDeleteResource :<|> (TimelineUpdateResource :<|> (ContactsInsertResource :<|> (ContactsListResource :<|> (ContactsPatchResource :<|> (ContactsGetResource :<|> (ContactsDeleteResource :<|> (ContactsUpdateResource :<|> (LocationsListResource :<|> LocationsGetResource)))))))))))))))))))))) Source #
Represents the entirety of the methods and resources available for the Google Mirror API service.
Resources
mirror.accounts.insert
mirror.contacts.delete
mirror.contacts.get
mirror.contacts.insert
mirror.contacts.list
mirror.contacts.patch
mirror.contacts.update
mirror.locations.get
mirror.locations.list
mirror.settings.get
mirror.subscriptions.delete
mirror.subscriptions.insert
mirror.subscriptions.list
mirror.subscriptions.update
mirror.timeline.attachments.delete
mirror.timeline.attachments.get
mirror.timeline.attachments.insert
mirror.timeline.attachments.list
mirror.timeline.delete
mirror.timeline.get
mirror.timeline.insert
mirror.timeline.list
mirror.timeline.patch
mirror.timeline.update
Types
TimelineListOrderBy
data TimelineListOrderBy Source #
Controls the order in which timeline items are returned.
Constructors
| DisplayTime |
|
| WriteTime |
|
Instances
NotificationConfig
data NotificationConfig Source #
Controls how notifications for a timeline item are presented to the user.
See: notificationConfig smart constructor.
Instances
notificationConfig :: NotificationConfig Source #
Creates a value of NotificationConfig with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ncDeliveryTime :: Lens' NotificationConfig (Maybe UTCTime) Source #
The time at which the notification should be delivered.
ncLevel :: Lens' NotificationConfig (Maybe Text) Source #
Describes how important the notification is. Allowed values are: - DEFAULT - Notifications of default importance. A chime will be played to alert users.
Command
A single menu command that is part of a Contact.
See: command smart constructor.
Instances
| Eq Command Source # | |
| Data Command Source # | |
Defined in Network.Google.Mirror.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Command -> c Command # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Command # toConstr :: Command -> Constr # dataTypeOf :: Command -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Command) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Command) # gmapT :: (forall b. Data b => b -> b) -> Command -> Command # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Command -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Command -> r # gmapQ :: (forall d. Data d => d -> u) -> Command -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Command -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Command -> m Command # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Command -> m Command # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Command -> m Command # | |
| Show Command Source # | |
| Generic Command Source # | |
| ToJSON Command Source # | |
Defined in Network.Google.Mirror.Types.Product | |
| FromJSON Command Source # | |
| type Rep Command Source # | |
Defined in Network.Google.Mirror.Types.Product | |
cType :: Lens' Command (Maybe Text) Source #
The type of operation this command corresponds to. Allowed values are: - TAKE_A_NOTE - Shares a timeline item with the transcription of user speech from the "Take a note" voice menu command. - POST_AN_UPDATE - Shares a timeline item with the transcription of user speech from the "Post an update" voice menu command.
LocationsListResponse
data LocationsListResponse Source #
A list of Locations. This is the response from the server to GET requests on the locations collection.
See: locationsListResponse smart constructor.
Instances
locationsListResponse :: LocationsListResponse Source #
Creates a value of LocationsListResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
llrKind :: Lens' LocationsListResponse Text Source #
The type of resource. This is always mirror#locationsList.
Location
A geographic location that can be associated with a timeline item.
See: location smart constructor.
Instances
Creates a value of Location with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lDisplayName :: Lens' Location (Maybe Text) Source #
The name to be displayed. This may be a business name or a user-defined place, such as "Home".
lTimestamp :: Lens' Location (Maybe UTCTime) Source #
The time at which this location was captured, formatted according to RFC 3339.
Notification
data Notification Source #
A notification delivered by the API.
See: notification smart constructor.
Instances
notification :: Notification Source #
Creates a value of Notification with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
nOperation :: Lens' Notification (Maybe Text) Source #
The type of operation that generated the notification.
nItemId :: Lens' Notification (Maybe Text) Source #
The ID of the item that generated the notification.
nCollection :: Lens' Notification (Maybe Text) Source #
The collection that generated the notification.
nUserActions :: Lens' Notification [UserAction] Source #
A list of actions taken by the user that triggered the notification.
nVerifyToken :: Lens' Notification (Maybe Text) Source #
The secret verify token provided by the service when it subscribed for notifications.
nUserToken :: Lens' Notification (Maybe Text) Source #
The user token provided by the service when it subscribed for notifications.
Contact
A person or group that can be used as a creator or a contact.
See: contact smart constructor.
Instances
Creates a value of Contact with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
conAcceptCommands :: Lens' Contact [Command] Source #
A list of voice menu commands that a contact can handle. Glass shows up to three contacts for each voice menu command. If there are more than that, the three contacts with the highest priority are shown for that particular command.
conSharingFeatures :: Lens' Contact [Text] Source #
A list of sharing features that a contact can handle. Allowed values are: - ADD_CAPTION
conImageURLs :: Lens' Contact [Text] Source #
Set of image URLs to display for a contact. Most contacts will have a single image, but a "group" contact may include up to 8 image URLs and they will be resized and cropped into a mosaic on the client.
conPriority :: Lens' Contact (Maybe Word32) Source #
Priority for the contact to determine ordering in a list of contacts. Contacts with higher priorities will be shown before ones with lower priorities.
conAcceptTypes :: Lens' Contact [Text] Source #
A list of MIME types that a contact supports. The contact will be shown to the user if any of its acceptTypes matches any of the types of the attachments on the item. If no acceptTypes are given, the contact will be shown for all items.
conPhoneNumber :: Lens' Contact (Maybe Text) Source #
Primary phone number for the contact. This can be a fully-qualified number, with country calling code and area code, or a local number.
conSource :: Lens' Contact (Maybe Text) Source #
The ID of the application that created this contact. This is populated by the API
conId :: Lens' Contact (Maybe Text) Source #
An ID for this contact. This is generated by the application and is treated as an opaque token.
conType :: Lens' Contact (Maybe Text) Source #
The type for this contact. This is used for sorting in UIs. Allowed values are: - INDIVIDUAL - Represents a single person. This is the default. - GROUP - Represents more than a single person.
conSpeakableName :: Lens' Contact (Maybe Text) Source #
Name of this contact as it should be pronounced. If this contact's name must be spoken as part of a voice disambiguation menu, this name is used as the expected pronunciation. This is useful for contact names with unpronounceable characters or whose display spelling is otherwise not phonetic.
AuthToken
Instances
| Eq AuthToken Source # | |
| Data AuthToken Source # | |
Defined in Network.Google.Mirror.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> AuthToken -> c AuthToken # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c AuthToken # toConstr :: AuthToken -> Constr # dataTypeOf :: AuthToken -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c AuthToken) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c AuthToken) # gmapT :: (forall b. Data b => b -> b) -> AuthToken -> AuthToken # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> AuthToken -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> AuthToken -> r # gmapQ :: (forall d. Data d => d -> u) -> AuthToken -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> AuthToken -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> AuthToken -> m AuthToken # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> AuthToken -> m AuthToken # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> AuthToken -> m AuthToken # | |
| Show AuthToken Source # | |
| Generic AuthToken Source # | |
| ToJSON AuthToken Source # | |
Defined in Network.Google.Mirror.Types.Product | |
| FromJSON AuthToken Source # | |
| type Rep AuthToken Source # | |
Defined in Network.Google.Mirror.Types.Product type Rep AuthToken = D1 (MetaData "AuthToken" "Network.Google.Mirror.Types.Product" "gogol-mirror-0.4.0-9c962MxnB494MCOxCUtS1H" False) (C1 (MetaCons "AuthToken'" PrefixI True) (S1 (MetaSel (Just "_atAuthToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_atType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) | |
authToken :: AuthToken Source #
Creates a value of AuthToken with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
AttachmentsListResponse
data AttachmentsListResponse Source #
A list of Attachments. This is the response from the server to GET requests on the attachments collection.
See: attachmentsListResponse smart constructor.
Instances
attachmentsListResponse :: AttachmentsListResponse Source #
Creates a value of AttachmentsListResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
alrKind :: Lens' AttachmentsListResponse Text Source #
The type of resource. This is always mirror#attachmentsList.
alrItems :: Lens' AttachmentsListResponse [Attachment] Source #
The list of attachments.
MenuItem
A custom menu item that can be presented to the user by a timeline item.
See: menuItem smart constructor.
Instances
Creates a value of MenuItem with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
miValues :: Lens' MenuItem [MenuValue] Source #
For CUSTOM items, a list of values controlling the appearance of the menu item in each of its states. A value for the DEFAULT state must be provided. If the PENDING or CONFIRMED states are missing, they will not be shown.
miRemoveWhenSelected :: Lens' MenuItem (Maybe Bool) Source #
If set to true on a CUSTOM menu item, that item will be removed from the menu after it is selected.
miAction :: Lens' MenuItem (Maybe Text) Source #
Controls the behavior when the user picks the menu option. Allowed values are: - CUSTOM - Custom action set by the service. When the user selects this menuItem, the API triggers a notification to your callbackUrl with the userActions.type set to CUSTOM and the userActions.payload set to the ID of this menu item. This is the default value. - Built-in actions: - REPLY - Initiate a reply to the timeline item using the voice recording UI. The creator attribute must be set in the timeline item for this menu to be available. - REPLY_ALL - Same behavior as REPLY. The original timeline item's recipients will be added to the reply item. - DELETE - Delete the timeline item. - SHARE - Share the timeline item with the available contacts. - READ_ALOUD - Read the timeline item's speakableText aloud; if this field is not set, read the text field; if none of those fields are set, this menu item is ignored. - GET_MEDIA_INPUT - Allow users to provide media payloads to Glassware from a menu item (currently, only transcribed text from voice input is supported). Subscribe to notifications when users invoke this menu item to receive the timeline item ID. Retrieve the media from the timeline item in the payload property. - VOICE_CALL - Initiate a phone call using the timeline item's creator.phoneNumber attribute as recipient. - NAVIGATE - Navigate to the timeline item's location. - TOGGLE_PINNED - Toggle the isPinned state of the timeline item. - OPEN_URI - Open the payload of the menu item in the browser. - PLAY_VIDEO - Open the payload of the menu item in the Glass video player. - SEND_MESSAGE - Initiate sending a message to the timeline item's creator: - If the creator.phoneNumber is set and Glass is connected to an Android phone, the message is an SMS. - Otherwise, if the creator.email is set, the message is an email.
miPayload :: Lens' MenuItem (Maybe Text) Source #
A generic payload whose meaning changes depending on this MenuItem's action. - When the action is OPEN_URI, the payload is the URL of the website to view. - When the action is PLAY_VIDEO, the payload is the streaming URL of the video - When the action is GET_MEDIA_INPUT, the payload is the text transcription of a user's speech input
miContextualCommand :: Lens' MenuItem (Maybe Text) Source #
The ContextualMenus.Command associated with this MenuItem (e.g. READ_ALOUD). The voice label for this command will be displayed in the voice menu and the touch label will be displayed in the touch menu. Note that the default menu value's display name will be overriden if you specify this property. Values that do not correspond to a ContextualMenus.Command name will be ignored.
miId :: Lens' MenuItem (Maybe Text) Source #
The ID for this menu item. This is generated by the application and is treated as an opaque token.
Setting
A setting for Glass.
See: setting smart constructor.
Instances
| Eq Setting Source # | |
| Data Setting Source # | |
Defined in Network.Google.Mirror.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Setting -> c Setting # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Setting # toConstr :: Setting -> Constr # dataTypeOf :: Setting -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Setting) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Setting) # gmapT :: (forall b. Data b => b -> b) -> Setting -> Setting # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Setting -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Setting -> r # gmapQ :: (forall d. Data d => d -> u) -> Setting -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Setting -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Setting -> m Setting # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Setting -> m Setting # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Setting -> m Setting # | |
| Show Setting Source # | |
| Generic Setting Source # | |
| ToJSON Setting Source # | |
Defined in Network.Google.Mirror.Types.Product | |
| FromJSON Setting Source # | |
| type Rep Setting Source # | |
Defined in Network.Google.Mirror.Types.Product type Rep Setting = D1 (MetaData "Setting" "Network.Google.Mirror.Types.Product" "gogol-mirror-0.4.0-9c962MxnB494MCOxCUtS1H" False) (C1 (MetaCons "Setting'" PrefixI True) (S1 (MetaSel (Just "_sKind") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: (S1 (MetaSel (Just "_sValue") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_sId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) | |
sId :: Lens' Setting (Maybe Text) Source #
The setting's ID. The following IDs are valid: - locale - The key to the user’s language/locale (BCP 47 identifier) that Glassware should use to render localized content. - timezone - The key to the user’s current time zone region as defined in the tz database. Example: America/Los_Angeles.
Attachment
data Attachment Source #
Represents media content, such as a photo, that can be attached to a timeline item.
See: attachment smart constructor.
Instances
attachment :: Attachment Source #
Creates a value of Attachment with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
aContentURL :: Lens' Attachment (Maybe Text) Source #
The URL for the content.
aIsProcessingContent :: Lens' Attachment (Maybe Bool) Source #
Indicates that the contentUrl is not available because the attachment content is still being processed. If the caller wishes to retrieve the content, it should try again later.
aContentType :: Lens' Attachment (Maybe Text) Source #
The MIME type of the attachment.
Account
Represents an account passed into the Account Manager on Glass.
See: account smart constructor.
Instances
| Eq Account Source # | |
| Data Account Source # | |
Defined in Network.Google.Mirror.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Account -> c Account # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Account # toConstr :: Account -> Constr # dataTypeOf :: Account -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Account) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Account) # gmapT :: (forall b. Data b => b -> b) -> Account -> Account # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Account -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Account -> r # gmapQ :: (forall d. Data d => d -> u) -> Account -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Account -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Account -> m Account # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Account -> m Account # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Account -> m Account # | |
| Show Account Source # | |
| Generic Account Source # | |
| ToJSON Account Source # | |
Defined in Network.Google.Mirror.Types.Product | |
| FromJSON Account Source # | |
| type Rep Account Source # | |
Defined in Network.Google.Mirror.Types.Product type Rep Account = D1 (MetaData "Account" "Network.Google.Mirror.Types.Product" "gogol-mirror-0.4.0-9c962MxnB494MCOxCUtS1H" False) (C1 (MetaCons "Account'" PrefixI True) ((S1 (MetaSel (Just "_aAuthTokens") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [AuthToken])) :*: S1 (MetaSel (Just "_aUserData") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [UserData]))) :*: (S1 (MetaSel (Just "_aPassword") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_aFeatures") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))))) | |
Creates a value of Account with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
UserData
Instances
| Eq UserData Source # | |
| Data UserData Source # | |
Defined in Network.Google.Mirror.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UserData -> c UserData # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UserData # toConstr :: UserData -> Constr # dataTypeOf :: UserData -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c UserData) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UserData) # gmapT :: (forall b. Data b => b -> b) -> UserData -> UserData # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UserData -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UserData -> r # gmapQ :: (forall d. Data d => d -> u) -> UserData -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> UserData -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> UserData -> m UserData # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UserData -> m UserData # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UserData -> m UserData # | |
| Show UserData Source # | |
| Generic UserData Source # | |
| ToJSON UserData Source # | |
Defined in Network.Google.Mirror.Types.Product | |
| FromJSON UserData Source # | |
| type Rep UserData Source # | |
Defined in Network.Google.Mirror.Types.Product type Rep UserData = D1 (MetaData "UserData" "Network.Google.Mirror.Types.Product" "gogol-mirror-0.4.0-9c962MxnB494MCOxCUtS1H" False) (C1 (MetaCons "UserData'" PrefixI True) (S1 (MetaSel (Just "_udValue") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_udKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) | |
UserAction
data UserAction Source #
Represents an action taken by the user that triggered a notification.
See: userAction smart constructor.
Instances
userAction :: UserAction Source #
Creates a value of UserAction with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
uaPayload :: Lens' UserAction (Maybe Text) Source #
An optional payload for the action. For actions of type CUSTOM, this is the ID of the custom menu item that was selected.
uaType :: Lens' UserAction (Maybe Text) Source #
The type of action. The value of this can be: - SHARE - the user shared an item. - REPLY - the user replied to an item. - REPLY_ALL - the user replied to all recipients of an item. - CUSTOM - the user selected a custom menu item on the timeline item. - DELETE - the user deleted the item. - PIN - the user pinned the item. - UNPIN - the user unpinned the item. - LAUNCH - the user initiated a voice command. In the future, additional types may be added. UserActions with unrecognized types should be ignored.
TimelineListResponse
data TimelineListResponse Source #
A list of timeline items. This is the response from the server to GET requests on the timeline collection.
See: timelineListResponse smart constructor.
Instances
timelineListResponse :: TimelineListResponse Source #
Creates a value of TimelineListResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tlrNextPageToken :: Lens' TimelineListResponse (Maybe Text) Source #
The next page token. Provide this as the pageToken parameter in the request to retrieve the next page of results.
tlrKind :: Lens' TimelineListResponse Text Source #
The type of resource. This is always mirror#timeline.
tlrItems :: Lens' TimelineListResponse [TimelineItem] Source #
Items in the timeline.
ContactsListResponse
data ContactsListResponse Source #
A list of Contacts representing contacts. This is the response from the server to GET requests on the contacts collection.
See: contactsListResponse smart constructor.
Instances
contactsListResponse :: ContactsListResponse Source #
Creates a value of ContactsListResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
clrKind :: Lens' ContactsListResponse Text Source #
The type of resource. This is always mirror#contacts.
MenuValue
A single value that is part of a MenuItem.
See: menuValue smart constructor.
Instances
| Eq MenuValue Source # | |
| Data MenuValue Source # | |
Defined in Network.Google.Mirror.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> MenuValue -> c MenuValue # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c MenuValue # toConstr :: MenuValue -> Constr # dataTypeOf :: MenuValue -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c MenuValue) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c MenuValue) # gmapT :: (forall b. Data b => b -> b) -> MenuValue -> MenuValue # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> MenuValue -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> MenuValue -> r # gmapQ :: (forall d. Data d => d -> u) -> MenuValue -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> MenuValue -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> MenuValue -> m MenuValue # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> MenuValue -> m MenuValue # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> MenuValue -> m MenuValue # | |
| Show MenuValue Source # | |
| Generic MenuValue Source # | |
| ToJSON MenuValue Source # | |
Defined in Network.Google.Mirror.Types.Product | |
| FromJSON MenuValue Source # | |
| type Rep MenuValue Source # | |
Defined in Network.Google.Mirror.Types.Product type Rep MenuValue = D1 (MetaData "MenuValue" "Network.Google.Mirror.Types.Product" "gogol-mirror-0.4.0-9c962MxnB494MCOxCUtS1H" False) (C1 (MetaCons "MenuValue'" PrefixI True) (S1 (MetaSel (Just "_mvState") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_mvDisplayName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_mvIconURL") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) | |
menuValue :: MenuValue Source #
Creates a value of MenuValue with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mvState :: Lens' MenuValue (Maybe Text) Source #
The state that this value applies to. Allowed values are: - DEFAULT - Default value shown when displayed in the menuItems list. - PENDING - Value shown when the menuItem has been selected by the user but can still be cancelled. - CONFIRMED - Value shown when the menuItem has been selected by the user and can no longer be cancelled.
mvDisplayName :: Lens' MenuValue (Maybe Text) Source #
The name to display for the menu item. If you specify this property for a built-in menu item, the default contextual voice command for that menu item is not shown.
Subscription
data Subscription Source #
A subscription to events on a collection.
See: subscription smart constructor.
Instances
subscription :: Subscription Source #
Creates a value of Subscription with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
subCallbackURL :: Lens' Subscription (Maybe Text) Source #
The URL where notifications should be delivered (must start with https://).
subOperation :: Lens' Subscription [Text] Source #
A list of operations that should be subscribed to. An empty list indicates that all operations on the collection should be subscribed to. Allowed values are: - UPDATE - The item has been updated. - INSERT - A new item has been inserted. - DELETE - The item has been deleted. - MENU_ACTION - A custom menu item has been triggered by the user.
subNotification :: Lens' Subscription (Maybe Notification) Source #
Container object for notifications. This is not populated in the Subscription resource.
subKind :: Lens' Subscription Text Source #
The type of resource. This is always mirror#subscription.
subCollection :: Lens' Subscription (Maybe Text) Source #
The collection to subscribe to. Allowed values are: - timeline - Changes in the timeline including insertion, deletion, and updates. - locations - Location updates. - settings - Settings updates.
subVerifyToken :: Lens' Subscription (Maybe Text) Source #
A secret token sent to the subscriber in notifications so that it can verify that the notification was generated by Google.
subUserToken :: Lens' Subscription (Maybe Text) Source #
An opaque token sent to the subscriber in notifications so that it can determine the ID of the user.
subUpdated :: Lens' Subscription (Maybe UTCTime) Source #
The time at which this subscription was last modified, formatted according to RFC 3339.
TimelineItem
data TimelineItem Source #
Each item in the user's timeline is represented as a TimelineItem JSON structure, described below.
See: timelineItem smart constructor.
Instances
timelineItem :: TimelineItem Source #
Creates a value of TimelineItem with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tiDisplayTime :: Lens' TimelineItem (Maybe UTCTime) Source #
The time that should be displayed when this item is viewed in the timeline, formatted according to RFC 3339. This user's timeline is sorted chronologically on display time, so this will also determine where the item is displayed in the timeline. If not set by the service, the display time defaults to the updated time.
tiIsDeleted :: Lens' TimelineItem (Maybe Bool) Source #
When true, indicates this item is deleted, and only the ID property is set.
tiPinScore :: Lens' TimelineItem (Maybe Int32) Source #
For pinned items, this determines the order in which the item is displayed in the timeline, with a higher score appearing closer to the clock. Note: setting this field is currently not supported.
tiAttachments :: Lens' TimelineItem [Attachment] Source #
A list of media attachments associated with this item. As a convenience,
you can refer to attachments in your HTML payloads with the attachment
or cid scheme. For example: - attachment:
where attachment_index is the 0-based
index of this array. - cid:
where attachment_id
is the ID of the attachment.
tiLocation :: Lens' TimelineItem (Maybe Location) Source #
The geographic location associated with this item.
tiMenuItems :: Lens' TimelineItem [MenuItem] Source #
A list of menu items that will be presented to the user when this item is selected in the timeline.
tiNotification :: Lens' TimelineItem (Maybe NotificationConfig) Source #
Controls how notifications for this item are presented on the device. If this is missing, no notification will be generated.
tiCreated :: Lens' TimelineItem (Maybe UTCTime) Source #
The time at which this item was created, formatted according to RFC 3339.
tiSpeakableText :: Lens' TimelineItem (Maybe Text) Source #
The speakable version of the content of this item. Along with the READ_ALOUD menu item, use this field to provide text that would be clearer when read aloud, or to provide extended information to what is displayed visually on Glass. Glassware should also specify the speakableType field, which will be spoken before this text in cases where the additional context is useful, for example when the user requests that the item be read aloud following a notification.
tiIsBundleCover :: Lens' TimelineItem (Maybe Bool) Source #
Whether this item is a bundle cover. If an item is marked as a bundle cover, it will be the entry point to the bundle of items that have the same bundleId as that item. It will be shown only on the main timeline — not within the opened bundle. On the main timeline, items that are shown are: - Items that have isBundleCover set to true - Items that do not have a bundleId In a bundle sub-timeline, items that are shown are: - Items that have the bundleId in question AND isBundleCover set to false
tiSpeakableType :: Lens' TimelineItem (Maybe Text) Source #
A speakable description of the type of this item. This will be announced to the user prior to reading the content of the item in cases where the additional context is useful, for example when the user requests that the item be read aloud following a notification. This should be a short, simple noun phrase such as "Email", "Text message", or "Daily Planet News Update". Glassware are encouraged to populate this field for every timeline item, even if the item does not contain speakableText or text so that the user can learn the type of the item without looking at the screen.
tiBundleId :: Lens' TimelineItem (Maybe Text) Source #
The bundle ID for this item. Services can specify a bundleId to group many items together. They appear under a single top-level item on the device.
tiCanonicalURL :: Lens' TimelineItem (Maybe Text) Source #
A canonical URL pointing to the canonical/high quality version of the data represented by the timeline item.
tiSelfLink :: Lens' TimelineItem (Maybe Text) Source #
A URL that can be used to retrieve this item.
tiIsPinned :: Lens' TimelineItem (Maybe Bool) Source #
When true, indicates this item is pinned, which means it's grouped alongside "active" items like navigation and hangouts, on the opposite side of the home screen from historical (non-pinned) timeline items. You can allow the user to toggle the value of this property with the TOGGLE_PINNED built-in menu item.
tiSourceItemId :: Lens' TimelineItem (Maybe Text) Source #
Opaque string you can use to map a timeline item to data in your own service.
tiId :: Lens' TimelineItem (Maybe Text) Source #
The ID of the timeline item. This is unique within a user's timeline.
tiHTML :: Lens' TimelineItem (Maybe Text) Source #
HTML content for this item. If both text and html are provided for an item, the html will be rendered in the timeline. Allowed HTML elements - You can use these elements in your timeline cards. - Headers: h1, h2, h3, h4, h5, h6 - Images: img - Lists: li, ol, ul - HTML5 semantics: article, aside, details, figure, figcaption, footer, header, nav, section, summary, time - Structural: blockquote, br, div, hr, p, span - Style: b, big, center, em, i, u, s, small, strike, strong, style, sub, sup - Tables: table, tbody, td, tfoot, th, thead, tr Blocked HTML elements: These elements and their contents are removed from HTML payloads. - Document headers: head, title - Embeds: audio, embed, object, source, video - Frames: frame, frameset - Scripting: applet, script Other elements: Any elements that aren't listed are removed, but their contents are preserved.
tiUpdated :: Lens' TimelineItem (Maybe UTCTime) Source #
The time at which this item was last modified, formatted according to RFC 3339.
tiRecipients :: Lens' TimelineItem [Contact] Source #
A list of users or groups that this item has been shared with.
tiInReplyTo :: Lens' TimelineItem (Maybe Text) Source #
If this item was generated as a reply to another item, this field will be set to the ID of the item being replied to. This can be used to attach a reply to the appropriate conversation or post.
SubscriptionsListResponse
data SubscriptionsListResponse Source #
A list of Subscriptions. This is the response from the server to GET requests on the subscription collection.
See: subscriptionsListResponse smart constructor.
Instances
subscriptionsListResponse :: SubscriptionsListResponse Source #
Creates a value of SubscriptionsListResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
slrKind :: Lens' SubscriptionsListResponse Text Source #
The type of resource. This is always mirror#subscriptionsList.
slrItems :: Lens' SubscriptionsListResponse [Subscription] Source #
The list of subscriptions.