googleplus-0.3.1.1: Haskell implementation of the Google+ API v1

Portabilityportable
Stabilityprovisional
MaintainerMichael Xavier <michael@michaelxavier.net>

Web.GooglePlus.Types

Description

 

Synopsis

Documentation

data Person Source

A member of Google+

Constructors

Person 

Fields

personId :: ID

Id of the Person

personDisplayName :: Text

Name of the Person, suitable for display

personName :: Maybe PersonName

Person's actual, full name

personNickName :: Maybe Text

Optional nickname of the Person

personTagline :: Maybe Text

Brief description of the Person

personBirthday :: Maybe Day

Person's Birthday

personGender :: Maybe Gender

Person's gender

personAboutMe :: Maybe Text

About Me profile section

personCurrentLocation :: Maybe Text

Current location of the Person

personRelationshipStatus :: Maybe RelationshipStatus

Person's current relationship status

personProfileURL :: URL

URL to the person's profile

personImage :: Image

Profile image for the Person

personEmails :: [Email]

Email addresses that the person uses

personURLs :: [PersonURL]

External URLs on the Person's profile

personOrganizations :: [Organization]

Organizations that the Person has belonged to, past and present

personPlacesLived :: [Place]

Places in which the Person has lived

personLanguagesSpoken :: [Language]

Languages the Person speaks

personHasApp :: Maybe Bool
 

data PersonSearchResult Source

A Person search result with limited informaiton. The full person's profile must be retrieved to get the rest

Constructors

PersonSearchResult 

Fields

personSRId :: ID

Id of the Person

personSRDisplayName :: Text

Name of the Person, suitable for display

personSRImage :: Image

Profile image for the Person

personSRProfileURL :: URL

URL to the person's profile

data PersonID Source

Identifier used for finding a Person

Constructors

PersonID Text

ID for a specific user

Me

The authenticated user

Instances

type ID = TextSource

data Actor Source

A person who may be associated with an Activity

Constructors

Actor 

Fields

actorDisplayName :: Text

The public display name of the Actor

actorId :: ID

The ID of the Actor

actorImage :: Image

Data pertaining to the Actor's main profile image

actorUrl :: URL

URL of the user's profile

data Verb Source

Type of activity being performed

Constructors

Post

Publish content to the stream

Checkin

Check into a location

Share

Reshare an activity

Instances

data ActivityObject Source

Object to which an activity pertains

Constructors

ActivityObject 

Fields

activityObjectActor :: Maybe Actor

If the object is another Activity, this refers to the actor for that Activity

activityObjectAttachments :: [Attachment]

Media objects attached to this activity object

activityObjectContent :: Text

Snipped of text if the object is an article

activityObjectId :: Maybe ID

ID of the media object's resource

activityObjectType :: ActivityObjectType

Type of Object

activityObjectOriginalContent :: Maybe Text

Content text as provided by the author without any HTML formatting

activityObjectPlusOners :: Integer

Number of people giving the Activity a +1

activityObjectReplies :: Integer

Number of replies to the Activity

activityObjectResharers :: Integer

Number of people resharing the Activity

activityObjectURL :: URL

URL pointing to the linked resource

data ActivityObjectType Source

Types of objects that can be associated with an Activity

Constructors

Note

Textual content

GooglePlusActivity

A Google+ Activity

data Provider Source

Service provider who originally published an Activity

Constructors

Provider 

Fields

providerTitle :: Text
 

data Access Source

Describes who has access to a given Activity resource

Constructors

Access 

Fields

accessDescription :: Maybe Text

Description of the access, suitable for display

accessItems :: [AccessItem]

List of access entries

data AccessItem Source

AccessEntry that describes the type of access someone may have to an Activity

Constructors

AccessItem 

Fields

accessItemId :: Maybe ID

ID of the entry. Only set when this AccessItem refers to a Person or Circle

accessItemType :: AccessItemType

Type of entity which has access to the associated Activity

data AccessItemType Source

Type of entity which may access an Activity

Constructors

PersonAccess 
CircleAccess 
MyCirclesAccess

Access granted to all members of the Actor's circles

ExtendedCirclesAccess

Access granted to members of the Actor's circles and their circles as well

PublicAccess

Access to anyone on the internet

data Geocode Source

Geolocation based on longitude and latitude

Constructors

Geocode 

data Activity Source

Activity on Google+, such as a post

Constructors

Activity 

Fields

activityPlaceholder :: Maybe Bool

Meaning undocumented

activityTitle :: Text

Title of the activity

activityPublished :: ZonedTime

Date originally published

activityUpdated :: ZonedTime

Date updated

activityId :: ID

Activity ID

activityURL :: URL

URL to view the Activity

activityActor :: Actor

The person who performed the Activity

activityVerb :: Verb

Indicates what action was performed

activityObject :: ActivityObject

The object of the Activity

activityAnnotation :: Maybe Text

Additional content added by the person who shared this activity, applicable only when resharing an activity

activityCrosspostSource :: Maybe ID

ID of original activity if this activity is a crosspost from another system

activityProvider :: Provider

Service provider initially providing the activity

activityAccess :: Access

Identifies who has access to this activity

activityGeocode :: Maybe Geocode

Where the activity occurred (Latitude/Longitude)

activityAddress :: Maybe Text

Street address where the activity occurred

activityRadius :: Maybe Integer

Radius of the region where the activity ocurred, centered at the Geocode

activityPlaceId :: Maybe ID

ID of the place where the activity occurred

activityPlaceName :: Maybe Text
 

data ActivityFeed Source

A feed of user activity

Constructors

ActivityFeed 

Fields

activityFeedTitle :: Text

Title of the feed in Google+

activityFeedUpdated :: ZonedTime

Time updated

activityFeedId :: ID

Unique ID of the feed

activityFeedItems :: [Activity]

Activities in the feed (currently limited to first page

Instances

data Attachment Source

Media attached to an Activity

Constructors

Attachment 

Fields

attachmentContent :: Maybe Text

Snippet of text if the Attachment is an article

attachmentDisplayName :: Maybe Text

Title of the Attachment

attachmentEmbed :: Maybe Embed

Embeddable link if the Attachment is a video

attachmentFullImage :: Maybe Image

Full image if the Attachment is a photo

attachmentId :: Maybe ID

ID of the Attachment's resource

attachmentImage :: Maybe Image

Preview image

attachmentType :: AttachmentType

Type of attachment

attachmentURL :: Maybe URL

Lin k to text/html attachment

data AttachmentType Source

Type of Activity Attachment

Constructors

Photo 
PhotoAlbum

A type that occurs in the wild but is not mentioned in the Google+ API docs

Video 
Article

An article attachment specified by a link by the poster

data Embed Source

Embeddable link for an attachment if it is a video

Constructors

Embed 

Fields

embedType :: Text

Type of embeddable link

embedUrl :: URL

Embeddable link

data Gender Source

Person's gender

Constructors

Male 
Female 
OtherGender 

data PersonName Source

Full, real name of a Person

Constructors

PersonName 

Fields

familyName :: Text
 
formatted :: Text

Fully formatted name of a Person including middle names, suffixes, etc.

givenName :: Text

The given (first) name of a Person

honorificPrefix :: Text

Prefix to a Person's name such as Dr. or Mrs.

honorificSuffix :: Text

Suffix of a Person's name such as Jr.

middleName :: Text
 

data Image Source

Image resource on Google+

Constructors

Image 

Fields

imageURL :: URL
 
imageType :: Maybe Text

Media type of the link

imageWidth :: Maybe Integer
 
imageHeight :: Maybe Integer
 

data Email Source

Email address belonging to the User

Constructors

Email 

Fields

emailPrimary :: Bool

Whether or not the Email is the Person's primary Email

emailType :: EmailType

Type/context of the Email address

emailAddressValue :: Text

The actual text address of the Email

data EmailType Source

Context/types of Emails that a Person can have

data PersonURL Source

External URLS that the Person has published

Constructors

PersonURL 

Fields

personUrlPrimary :: Bool

Whether or not the URL is the Person's primary URl

personUrlType :: Maybe PersonURLType

Type of URL

personURLValue :: URL

Actual text URl for the Person

data PersonURLType Source

Context/types of URLS that a Person can have

Constructors

HomeURL 
WorkURL 
BlogURL 
ProfileURL 
JsonURL

This is not a documented value, yet I've encountered it in the wild. I have no idea what it means.

OtherURL 

data Organization Source

Organization to which a Persion currently or previously may belong

Constructors

Organization 

Fields

organizationDepartment :: Maybe Text

Department of an Organization in which the Person resided

organizationDescription :: Maybe Text

General description of the Organization

organizationEndDate :: Maybe Text

Date on which the user stopped at the organization in an unspecified text format

organizationLocation :: Maybe Text

Location of the Organization

organizationName :: Text

Name of the Organization

organizationPrimary :: Bool

Whether or not this Organization was the Person's primary one

organizationstartDate :: Maybe Text

Date on which the user started at the organization in an unspecified text format

organizationTitle :: Text

The Person's role at the Organization

organizationType :: OrganizationType

The type of Organization

data OrganizationType Source

The capacity in which the Perosn participated in an Organization

Constructors

Work 
School 

data Place Source

A physical location where a Person resides/resided

Constructors

Place 

Fields

placePrimary :: Bool

Whether or not this is/was the Person's primary residence

placeValue :: Text

Text description of the Place

data Comment Source

Activity comment on Google+

Constructors

Comment 

Fields

commentId :: ID

ID of the comment

commentPublished :: ZonedTime

Date originally published

commentUpdated :: ZonedTime

Date updated

commentActor :: Actor

The actor who posted the comment

commentVerb :: Verb

Indicates what action was performed

commentObject :: CommentObject

The content of the object

commentUrl :: URL

URL to the comment

commentActivities :: [InReplyTo]

The activities to which this comment is a reply

data CommentObject Source

Constructors

CommentObject 

Fields

commentObjectContent :: Text

Text content of the comments

data InReplyTo Source

Constructors

InReplyTo 

Fields

inReplyToId :: ID

ID of the article

inReplyToUrl :: URL

URL of the article