Google Data APIs Client Library

com.google.gdata.client.calendar
Class CalendarService

java.lang.Object
  com.google.gdata.client.Service
      com.google.gdata.client.GoogleService
          com.google.gdata.client.calendar.CalendarService

All Implemented Interfaces:

AuthTokenFactory.TokenListener

public class CalendarService
extends GoogleService

The CalendarService class extends the basic GoogleService abstraction to define a service that is preconfigured for access to the Google Calendar data API.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gdata.client.GoogleService

GoogleService.AccountDeletedException, GoogleService.AccountDisabledException, GoogleService.AuthSubToken, GoogleService.CaptchaRequiredException, GoogleService.InvalidCredentialsException, GoogleService.NotVerifiedException, GoogleService.ServiceUnavailableException, GoogleService.SessionExpiredException, GoogleService.TermsNotAgreedException, GoogleService.UserToken

Nested classes/interfaces inherited from class com.google.gdata.client.Service

Service.GDataRequest, Service.GDataRequestFactory, Service.Versions

Field Summary

static java.lang.String	CALENDAR_ROOT_URL The root URL of Calendar feeds.
static java.lang.String	CALENDAR_SERVICE The abbreviated name of Calendar recognized by Google.
static java.lang.String	CALENDAR_SERVICE_VERSION

Fields inherited from class com.google.gdata.client.Service

connectTimeout, extProfile, requestFactory

Constructor Summary

CalendarService(java.lang.String applicationName)
Constructs a CalendarService instance connecting to the Calendar service for an application with the name applicationName.

CalendarService(java.lang.String applicationName, java.lang.String protocol, java.lang.String domainName)
Constructs a GoogleService instance connecting to the service with name serviceName for an application with the name applicationName.

Method Summary

java.lang.String

getServiceVersion() Returns information about the service version.

Methods inherited from class com.google.gdata.client.GoogleService

addCookie, createRequest, delete, delete, getAuthToken, getAuthTokenFactory, getCookieManager, getCookies, getEntry, getEntry, getFeed, getFeed, getFeed, getFeed, handleRedirectException, handlesCookies, handleSessionExpiredException, insert, makePostRequest, setAuthSubToken, setAuthSubToken, setAuthTokenFactory, setCookieManager, setHandlesCookies, setUserCredentials, setUserCredentials, setUserToken, tokenChanged, update

Methods inherited from class com.google.gdata.client.Service

batch, closeSource, createBatchRequest, createDeleteRequest, createEntryRequest, createFeedRequest, createFeedRequest, createInsertRequest, createUpdateRequest, getContentType, getEntry, getExtensionProfile, getFeed, getFeed, getRequestFactory, getStreamFromLink, getVersion, initServiceVersion, introspect, parseEntry, query, query, query, setConnectTimeout, setContentType, setExtensionProfile, setReadTimeout, setRequestFactory, setTimeouts, update, useSsl

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CALENDAR_SERVICE

public static final java.lang.String CALENDAR_SERVICE

The abbreviated name of Calendar recognized by Google. The service name is used while requesting an authentication token.

See Also:

Constant Field Values

CALENDAR_ROOT_URL

public static final java.lang.String CALENDAR_ROOT_URL

The root URL of Calendar feeds. This URL will be used to scope the AuthSub (authentication for web services) tokens.

See Also:

Constant Field Values

CALENDAR_SERVICE_VERSION

public static final java.lang.String CALENDAR_SERVICE_VERSION

Constructor Detail

CalendarService

public CalendarService(java.lang.String applicationName)

Constructs a CalendarService instance connecting to the Calendar service for an application with the name applicationName.

Parameters:

applicationName - the name of the client application accessing the service. Application names should preferably have the format [company-id]-[app-name]-[app-version]. The name will be used by the Google servers to monitor the source of authentication.

CalendarService

public CalendarService(java.lang.String applicationName,
                       java.lang.String protocol,
                       java.lang.String domainName)

Constructs a GoogleService instance connecting to the service with name serviceName for an application with the name applicationName. The service will authenticate at the provided domainName.

Parameters:

applicationName - the name of the client application accessing the service. Application names should preferably have the format [company-id]-[app-name]-[app-version]. The name will be used by the Google servers to monitor the source of authentication.

protocol - name of protocol to use for authentication ("http"/"https")

domainName - the name of the domain hosting the login handler

Method Detail

getServiceVersion

public java.lang.String getServiceVersion()

Description copied from class: Service

Returns information about the service version.

Overrides:

getServiceVersion in class Service