gogol-apps-activity-0.0.1: Google Apps Activity SDK.

Copyright(c) 2015 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.Google.AppsActivity.Types

Contents

Description

 

Synopsis

Service Configuration

appsActivityService :: Service Source

Default request referring to version v1 of the Google Apps Activity API. This contains the host and root path used as a starting point for constructing service requests.

OAuth Scopes

driveMetadataReadonlyScope :: OAuthScope Source

View metadata for files in your Google Drive

activityScope :: OAuthScope Source

View the activity history of your Google Apps

driveReadonlyScope :: OAuthScope Source

View the files in your Google Drive

driveScope :: OAuthScope Source

View and manage the files in your Google Drive

driveMetadataScope :: OAuthScope Source

View and manage metadata of files in your Google Drive

Parent

data Parent Source

Contains information about a parent object. For example, a folder in Drive is a parent for all files within it.

See: parent smart constructor.

parent :: Parent Source

Creates a value of Parent with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

pIsRoot :: Lens' Parent (Maybe Bool) Source

Whether this is the root folder.

pId :: Lens' Parent (Maybe Text) Source

The parent's ID.

pTitle :: Lens' Parent (Maybe Text) Source

The parent's title.

Photo

data Photo Source

Photo information for a user.

See: photo smart constructor.

photo :: Photo Source

Creates a value of Photo with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

pURL :: Lens' Photo (Maybe Text) Source

The URL of the photo.

EventPrimaryEventType

Event

data Event Source

Represents the changes associated with an action taken by a user.

See: event smart constructor.

event :: Event Source

Creates a value of Event with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

ePrimaryEventType :: Lens' Event (Maybe EventPrimaryEventType) Source

The main type of event that occurred.

eUser :: Lens' Event (Maybe User) Source

Represents the user responsible for the event.

eEventTimeMillis :: Lens' Event (Maybe Word64) Source

The time at which the event occurred formatted as Unix time in milliseconds.

eRename :: Lens' Event (Maybe Rename) Source

Extra information for rename type events, such as the old and new names.

eFromUserDeletion :: Lens' Event (Maybe Bool) Source

Whether this event is caused by a user being deleted.

eAdditionalEventTypes :: Lens' Event [EventAdditionalEventTypesItem] Source

Additional event types. Some events may have multiple types when multiple actions are part of a single event. For example, creating a document, renaming it, and sharing it may be part of a single file-creation event.

ePermissionChanges :: Lens' Event [PermissionChange] Source

Extra information for permissionChange type events, such as the user or group the new permission applies to.

eTarget :: Lens' Event (Maybe Target) Source

Information specific to the Target object modified by the event.

eMove :: Lens' Event (Maybe Move) Source

Extra information for move type events, such as changes in an object's parents.

PermissionRole

ListActivitiesResponse

data ListActivitiesResponse Source

The response from the list request. Contains a list of activities and a token to retrieve the next page of results.

See: listActivitiesResponse smart constructor.

listActivitiesResponse :: ListActivitiesResponse Source

Creates a value of ListActivitiesResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

larNextPageToken :: Lens' ListActivitiesResponse (Maybe Text) Source

Token for the next page of results.

PermissionChange

data PermissionChange Source

Contains information about a Drive object's permissions that changed as a result of a permissionChange type event.

See: permissionChange smart constructor.

permissionChange :: PermissionChange Source

Creates a value of PermissionChange with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

pcAddedPermissions :: Lens' PermissionChange [Permission] Source

Lists all Permission objects added.

pcRemovedPermissions :: Lens' PermissionChange [Permission] Source

Lists all Permission objects removed.

PermissionType

User

data User Source

A representation of a user.

See: user smart constructor.

user :: User Source

Creates a value of User with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

uPhoto :: Lens' User (Maybe Photo) Source

The profile photo of the user.

uName :: Lens' User (Maybe Text) Source

The displayable name of the user.

EventAdditionalEventTypesItem

Activity

data Activity Source

An Activity resource is a combined view of multiple events. An activity has a list of individual events and a combined view of the common fields among all events.

See: activity smart constructor.

activity :: Activity Source

Creates a value of Activity with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

aSingleEvents :: Lens' Activity [Event] Source

A list of all the Events that make up the Activity.

aCombinedEvent :: Lens' Activity (Maybe Event) Source

The fields common to all of the singleEvents that make up the Activity.

ActivitiesListGroupingStrategy

Rename

data Rename Source

Contains information about a renametype event.

See: rename smart constructor.

rename :: Rename Source

Creates a value of Rename with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

rNewTitle :: Lens' Rename (Maybe Text) Source

The new title.

rOldTitle :: Lens' Rename (Maybe Text) Source

The old title.

Permission

data Permission Source

Contains information about the permissions and type of access allowed with regards to a Google Drive object. This is a subset of the fields contained in a corresponding Drive Permissions object.

See: permission smart constructor.

permission :: Permission Source

Creates a value of Permission with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

pWithLink :: Lens' Permission (Maybe Bool) Source

Whether the permission requires a link to the file.

pUser :: Lens' Permission (Maybe User) Source

The user's information if the type is USER.

pRole :: Lens' Permission (Maybe PermissionRole) Source

Indicates the Google Drive permissions role. The role determines a user's ability to read, write, or comment on the file.

pName :: Lens' Permission (Maybe Text) Source

The name of the user or group the permission applies to.

pType :: Lens' Permission (Maybe PermissionType) Source

Indicates how widely permissions are granted.

pPermissionId :: Lens' Permission (Maybe Text) Source

The ID for this permission. Corresponds to the Drive API's permission ID returned as part of the Drive Permissions resource.

Target

data Target Source

Information about the object modified by the event.

See: target smart constructor.

target :: Target Source

Creates a value of Target with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

tMimeType :: Lens' Target (Maybe Text) Source

The MIME type of the target.

tName :: Lens' Target (Maybe Text) Source

The name of the target. For example, in Google Drive, this is the title of the file.

tId :: Lens' Target (Maybe Text) Source

The ID of the target. For example, in Google Drive, this is the file or folder ID.

Move

data Move Source

Contains information about changes in an object's parents as a result of a move type event.

See: move smart constructor.

move :: Move Source

Creates a value of Move with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

mAddedParents :: Lens' Move [Parent] Source

The added parent(s).

mRemovedParents :: Lens' Move [Parent] Source

The removed parent(s).