Author: api.rpropper
Date: Mon Apr 16 08:11:41 2007
New Revision: 139
Modified:
trunk/clients/cs/src/gapps/appsexception.cs
trunk/clients/cs/src/gapps/email_list.cs
trunk/clients/cs/src/gapps/emaillistentry.cs
trunk/clients/cs/src/gapps/emaillistfeed.cs
trunk/clients/cs/src/gapps/emaillistquery.cs
trunk/clients/cs/src/gapps/emaillistrecipiententry.cs
trunk/clients/cs/src/gapps/emaillistrecipientfeed.cs
trunk/clients/cs/src/gapps/emaillistrecipientquery.cs
trunk/clients/cs/src/gapps/login.cs
trunk/clients/cs/src/gapps/name.cs
trunk/clients/cs/src/gapps/nickname.cs
trunk/clients/cs/src/gapps/nicknameentry.cs
trunk/clients/cs/src/gapps/nicknamefeed.cs
trunk/clients/cs/src/gapps/nicknamequery.cs
trunk/clients/cs/src/gapps/quota.cs
trunk/clients/cs/src/gapps/userentry.cs
trunk/clients/cs/src/gapps/userquery.cs
Log:
Added comments that were missing from a few public properties,
methods and class declarations.
Modified: trunk/clients/cs/src/gapps/appsexception.cs
==============================================================================
--- trunk/clients/cs/src/gapps/appsexception.cs (original)
+++ trunk/clients/cs/src/gapps/appsexception.cs Mon Apr 16 08:11:41 2007
@@ -1,12 +1,14 @@
using System;
-// using System.Text;
- using System.Net;
-// using System.IO;
+using System.Net;
using System.Xml;
using Google.GData.Client;
namespace Google.GData.Apps
{
+ /// <summary>
+ /// The AppsException class defines an error resulting from
+ /// a Google Apps provisioning request.
+ /// </summary>
public class AppsException : GDataRequestException
{
private string errorCode;
@@ -15,20 +17,101 @@
#region Defined Google Apps error codes
+ /// <summary>
+ /// Google Apps error indicating that the request failed
+ /// for an unknown reason.
+ /// </summary>
public const string UnknownError = "1000";
+
+ /// <summary>
+ /// Google Apps error indicating that the request instructs
+ /// Google to create a new user but uses the username of an
+ /// account that was deleted in the previous five days.
+ /// </summary>
public const string UserDeletedRecently = "1100";
+
+ /// <summary>
+ /// Google Apps error indicating that the user identified in
+ /// the request is suspended.
+ /// </summary>
public const string UserSuspended = "1101";
+
+ /// <summary>
+ /// Google Apps error indicating that the specified domain has
+ /// already reached its quota of user accounts.
+ /// </summary>
public const string DomainUserLimitExceeded = "1200";
+
+ /// <summary>
+ /// Google Apps error indicating that the specified domain has
+ /// already reached its quota of aliases. Aliases include
+ /// nicknames and email lists.
+ /// </summary>
public const string DomainAliasLimitExceeded = "1201";
+
+ /// <summary>
+ /// Google Apps error indicating that Google has suspended the
+ /// specified domain's access to Google Apps.
+ /// </summary>
public const string DomainSuspended = "1202";
+
+ /// <summary>
+ /// Google Apps error indicating that the request instructs
+ /// Google to create an entity that already exists.
+ /// </summary>
public const string EntityExists = "1300";
+
+ /// <summary>
+ /// Google Apps error indicating that the request asks Google
+ /// to retrieve an entity that does not exist.
+ /// </summary>
public const string EntityDoesNotExist = "1301";
+
+ /// <summary>
+ /// Google Apps error indicating that the request instructs
+ /// Google to create an entity with a reserved name, such as
+ /// "abuse" or "postmaster".
+ /// </summary>
public const string EntityNameIsReserved = "1302";
+
+ /// <summary>
+ /// Google Apps error indicating that the request provides an
+ /// invalid name for a requested resource.
+ /// </summary>
public const string EntityNameNotValid = "1303";
+
+ /// <summary>
+ /// Google Apps error indicating that the value in the API request
+ /// for the user's first name, or given name, contains unaccepted
+ /// characters.
+ /// </summary>
public const string InvalidGivenName = "1400";
+
+ /// <summary>
+ /// Google Apps error indicating that the value in the API request
+ /// for the user's surname, or family name, contains unaccepted
+ /// characters.
+ /// </summary>
public const string InvalidFamilyName = "1401";
+
+ /// <summary>
+ /// Google Apps error indicating that the value in the API request
+ /// for the user's password contains an invalid number of characters
+ /// or unaccepted characters.
+ /// </summary>
public const string InvalidPassword = "1402";
+
+ /// <summary>
+ /// Google Apps error indicating that the value in the API request
+ /// for the user's username contains unaccepted characters.
+ /// </summary>
public const string InvalidUsername = "1403";
+
+ /// <summary>
+ /// Google Apps error indicating that the request instructs Google
+ /// to add users to an email list, but that list has already reached
+ /// the maximum number of subscribers.
+ /// </summary>
public const string TooManyRecipientsOnEmailList = "1500";
#endregion
Modified: trunk/clients/cs/src/gapps/email_list.cs
==============================================================================
--- trunk/clients/cs/src/gapps/email_list.cs (original)
+++ trunk/clients/cs/src/gapps/email_list.cs Mon Apr 16 08:11:41 2007
@@ -21,8 +21,8 @@
namespace Google.GData.Apps
{
/// <summary>
- /// Apps name space element: <apps:emailList>. Used to model
- /// an email list in Google Apps. Has attribute "name".
+ /// Extension element sed to model a Google Apps email list.
+ /// Has attribute "name".
/// </summary>
public class EmailListElement : IExtensionElement
{
@@ -57,7 +57,6 @@
//////////////////////////////////////////////////////////////////////
/// <summary>parses an xml node to create an EmailList
object</summary>
/// <param name="node">emailList node</param>
- /// <param name="parser">AtomFeedParser to use</param>
/// <returns> the created EmailList object</returns>
//////////////////////////////////////////////////////////////////////
public static EmailListElement ParseEmailList(XmlNode node)
Modified: trunk/clients/cs/src/gapps/emaillistentry.cs
==============================================================================
--- trunk/clients/cs/src/gapps/emaillistentry.cs (original)
+++ trunk/clients/cs/src/gapps/emaillistentry.cs Mon Apr 16 08:11:41 2007
@@ -21,6 +21,10 @@
namespace Google.GData.Apps
{
+ /// <summary>
+ /// A Google Apps email list entry. An EmailListEntry object
+ /// contains information about a single email list.
+ /// </summary>
public class EmailListEntry : AtomEntry
{
/// <summary>
Modified: trunk/clients/cs/src/gapps/emaillistfeed.cs
==============================================================================
--- trunk/clients/cs/src/gapps/emaillistfeed.cs (original)
+++ trunk/clients/cs/src/gapps/emaillistfeed.cs Mon Apr 16 08:11:41 2007
@@ -26,6 +26,12 @@
/// </summary>
public class EmailListFeed : AtomFeed
{
+ /// <summary>
+ /// Constructs a new EmailListFeed.
+ /// </summary>
+ /// <param name="uriBase">the feed URI</param>
+ /// <param name="iService">the Service object with which
+ /// this feed is to be associated</param>
public EmailListFeed(Uri uriBase, IService iService)
: base(uriBase, iService)
{
Modified: trunk/clients/cs/src/gapps/emaillistquery.cs
==============================================================================
--- trunk/clients/cs/src/gapps/emaillistquery.cs (original)
+++ trunk/clients/cs/src/gapps/emaillistquery.cs Mon Apr 16 08:11:41 2007
@@ -20,15 +20,15 @@
using System.Collections;
using Google.GData.Client;
-/// <summary>
-/// A subclass of FeedQuery to query a Google Apps email list
-/// feed URI.
-///
-/// Provides public properties that describe the different
-/// aspects of the URI, as well as a composite URI.
-/// </summary>
namespace Google.GData.Apps
-{
+{
+ /// <summary>
+ /// A subclass of FeedQuery to query a Google Apps email list
+ /// feed URI.
+ ///
+ /// Provides public properties that describe the different
+ /// aspects of the URI, as well as a composite URI.
+ /// </summary>
public class EmailListQuery : FeedQuery
{
private const string feedUriExtension = "/emailList/2.0";
Modified: trunk/clients/cs/src/gapps/emaillistrecipiententry.cs
==============================================================================
--- trunk/clients/cs/src/gapps/emaillistrecipiententry.cs (original)
+++ trunk/clients/cs/src/gapps/emaillistrecipiententry.cs Mon Apr 16
08:11:41 2007
@@ -22,6 +22,11 @@
namespace Google.GData.Apps
{
+ /// <summary>
+ /// A Google Apps email list recipient entry. This class
+ /// defines a single recipient on an email list using a Who
+ /// (gd:who) object.
+ /// </summary>
public class EmailListRecipientEntry : AtomEntry
{
/// <summary>
@@ -34,12 +39,23 @@
private Who recipient;
+ /// <summary>
+ /// Constructs a new EmailListRecipientEntry without
+ /// setting the Recipient property.
+ /// </summary>
public EmailListRecipientEntry()
: base()
{
Categories.Add(EMAILLIST_RECIPIENT_CATEGORY);
}
+ /// <summary>
+ /// Constructs a new EmailListRecipientEntry, using
+ /// the specified email address to initialize the
+ /// Recipient property.
+ /// </summary>
+ /// <param name="recipientAddress">the recipient's
+ /// email address</param>
public EmailListRecipientEntry(String recipientAddress)
: base()
{
Modified: trunk/clients/cs/src/gapps/emaillistrecipientfeed.cs
==============================================================================
--- trunk/clients/cs/src/gapps/emaillistrecipientfeed.cs (original)
+++ trunk/clients/cs/src/gapps/emaillistrecipientfeed.cs Mon Apr 16
08:11:41 2007
@@ -20,12 +20,18 @@
using Google.GData.Extensions;
namespace Google.GData.Apps
-{
- /// <summary>
- /// Feed API customization class for defining email list recipient feed.
+{
+ /// <summary>
+ /// Feed API customization class for defining email list recipient feed.
/// </summary>
public class EmailListRecipientFeed : AtomFeed
{
+ /// <summary>
+ /// Constructs a new EmailListRecipientFeed.
+ /// </summary>
+ /// <param name="uriBase">the feed URI</param>
+ /// <param name="iService">the Service object with which this
+ /// feed is to be be associated</param>
public EmailListRecipientFeed(Uri uriBase, IService iService)
: base(uriBase, iService)
{
Modified: trunk/clients/cs/src/gapps/emaillistrecipientquery.cs
==============================================================================
--- trunk/clients/cs/src/gapps/emaillistrecipientquery.cs (original)
+++ trunk/clients/cs/src/gapps/emaillistrecipientquery.cs Mon Apr 16
08:11:41 2007
@@ -20,15 +20,15 @@
using System.Collections;
using Google.GData.Client;
-/// <summary>
-/// A subclass of FeedQuery to query a Google Apps email list
-/// recipient feed URI.
-///
-/// Provides public properties that describe the different
-/// aspects of the URI, as well as a composite URI.
-/// </summary>
namespace Google.GData.Apps
-{
+{
+ /// <summary>
+ /// A subclass of FeedQuery to query a Google Apps email list
+ /// recipient feed URI.
+ ///
+ /// Provides public properties that describe the different
+ /// aspects of the URI, as well as a composite URI.
+ /// </summary>
public class EmailListRecipientQuery : FeedQuery
{
private const string feedUriExtension = "/emailList/2.0";
Modified: trunk/clients/cs/src/gapps/login.cs
==============================================================================
--- trunk/clients/cs/src/gapps/login.cs (original)
+++ trunk/clients/cs/src/gapps/login.cs Mon Apr 16 08:11:41 2007
@@ -108,7 +108,6 @@
//////////////////////////////////////////////////////////////////////
/// <summary>parses an xml node to create a LoginElement
object</summary>
/// <param name="node">login node</param>
- /// <param name="parser">AtomFeedParser to use</param>
/// <returns> the created Login object</returns>
//////////////////////////////////////////////////////////////////////
public static LoginElement ParseLogin(XmlNode node)
Modified: trunk/clients/cs/src/gapps/name.cs
==============================================================================
--- trunk/clients/cs/src/gapps/name.cs (original)
+++ trunk/clients/cs/src/gapps/name.cs Mon Apr 16 08:11:41 2007
@@ -68,7 +68,6 @@
//////////////////////////////////////////////////////////////////////
/// <summary>parses an xml node to create a NameElement
object</summary>
/// <param name="node">name node</param>
- /// <param name="parser">AtomFeedParser to use</param>
/// <returns> the created NameElement object</returns>
//////////////////////////////////////////////////////////////////////
public static NameElement ParseName(XmlNode node)
Modified: trunk/clients/cs/src/gapps/nickname.cs
==============================================================================
--- trunk/clients/cs/src/gapps/nickname.cs (original)
+++ trunk/clients/cs/src/gapps/nickname.cs Mon Apr 16 08:11:41 2007
@@ -21,8 +21,8 @@
namespace Google.GData.Apps
{
/// <summary>
- /// Apps name space element: <apps:nickname>. Used to model
- /// a nickname in Google Apps. Has attribute "name".
+ /// Extension element used to model a nickname in
+ /// Google Apps. Has attribute "name".
/// </summary>
public class NicknameElement : IExtensionElement
{
@@ -57,7 +57,6 @@
//////////////////////////////////////////////////////////////////////
/// <summary>parses an xml node to create a NicknameElement
object</summary>
/// <param name="node">nickname node</param>
- /// <param name="parser">AtomFeedParser to use</param>
/// <returns> the created NicknameElement object</returns>
//////////////////////////////////////////////////////////////////////
public static NicknameElement ParseNickname(XmlNode node)
Modified: trunk/clients/cs/src/gapps/nicknameentry.cs
==============================================================================
--- trunk/clients/cs/src/gapps/nicknameentry.cs (original)
+++ trunk/clients/cs/src/gapps/nicknameentry.cs Mon Apr 16 08:11:41 2007
@@ -21,6 +21,10 @@
namespace Google.GData.Apps
{
+ /// <summary>
+ /// A Google Apps nickname entry. A NicknameEntry identifies a
+ /// nickname and the user to whom the nickname is assigned.
+ /// </summary>
public class NicknameEntry : AtomEntry
{
/// <summary>
Modified: trunk/clients/cs/src/gapps/nicknamefeed.cs
==============================================================================
--- trunk/clients/cs/src/gapps/nicknamefeed.cs (original)
+++ trunk/clients/cs/src/gapps/nicknamefeed.cs Mon Apr 16 08:11:41 2007
@@ -20,12 +20,18 @@
using Google.GData.Extensions;
namespace Google.GData.Apps
-{
- /// <summary>
- /// Feed API customization class for defining nickname feed.
+{
+ /// <summary>
+ /// Feed API customization class for defining nickname feed.
/// </summary>
public class NicknameFeed : AtomFeed
{
+ /// <summary>
+ /// Constructs a new NicknameFeed.
+ /// </summary>
+ /// <param name="uriBase">the URI of the feed</param>
+ /// <param name="iService">the service with which this
+ /// feed will be associated</param>
public NicknameFeed(Uri uriBase, IService iService)
: base(uriBase, iService)
{
Modified: trunk/clients/cs/src/gapps/nicknamequery.cs
==============================================================================
--- trunk/clients/cs/src/gapps/nicknamequery.cs (original)
+++ trunk/clients/cs/src/gapps/nicknamequery.cs Mon Apr 16 08:11:41 2007
@@ -20,15 +20,15 @@
using System.Collections;
using Google.GData.Client;
-/// <summary>
-/// A subclass of FeedQuery to query a Google Apps nickname
-/// feed URI.
-///
-/// Provides public properties that describe the different
-/// aspects of the URI, as well as a composite URI.
-/// </summary>
namespace Google.GData.Apps
-{
+{
+ /// <summary>
+ /// A subclass of FeedQuery to query a Google Apps nickname
+ /// feed URI.
+ ///
+ /// Provides public properties that describe the different
+ /// aspects of the URI, as well as a composite URI.
+ /// </summary>
public class NicknameQuery : FeedQuery
{
private const string feedUriExtension = "/nickname/2.0";
Modified: trunk/clients/cs/src/gapps/quota.cs
==============================================================================
--- trunk/clients/cs/src/gapps/quota.cs (original)
+++ trunk/clients/cs/src/gapps/quota.cs Mon Apr 16 08:11:41 2007
@@ -56,7 +56,6 @@
//////////////////////////////////////////////////////////////////////
/// <summary>parses an xml node to create a QuotaElement
object</summary>
/// <param name="node">quota node</param>
- /// <param name="parser">AtomFeedParser to use</param>
/// <returns> the created QuotaElement object</returns>
//////////////////////////////////////////////////////////////////////
public static QuotaElement ParseQuota(XmlNode node)
Modified: trunk/clients/cs/src/gapps/userentry.cs
==============================================================================
--- trunk/clients/cs/src/gapps/userentry.cs (original)
+++ trunk/clients/cs/src/gapps/userentry.cs Mon Apr 16 08:11:41 2007
@@ -21,6 +21,10 @@
namespace Google.GData.Apps
{
+ /// <summary>
+ /// A Google Apps user entry. A UserEntry object encapsulates
+ /// the login, name and quota information for a single user.
+ /// </summary>
public class UserEntry : AtomEntry
{
/// <summary>
Modified: trunk/clients/cs/src/gapps/userquery.cs
==============================================================================
--- trunk/clients/cs/src/gapps/userquery.cs (original)
+++ trunk/clients/cs/src/gapps/userquery.cs Mon Apr 16 08:11:41 2007
@@ -20,15 +20,15 @@
using System.Collections;
using Google.GData.Client;
-/// <summary>
-/// A subclass of FeedQuery to query a Google Apps user
-/// accounts feed URI.
-///
-/// Provides public properties that describe the different
-/// aspects of the URI, as well as a composite URI.
-/// </summary>
namespace Google.GData.Apps
-{
+{
+ /// <summary>
+ /// A subclass of FeedQuery to query a Google Apps user
+ /// accounts feed URI.
+ ///
+ /// Provides public properties that describe the different
+ /// aspects of the URI, as well as a composite URI.
+ /// </summary>
public class UserQuery : FeedQuery
{
private const string feedUriExtension = "/user/2.0";
--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups
"Google Data API" group.
To post to this group, send email to [email protected]
To unsubscribe from this group, send email to [EMAIL PROTECTED]
For more options, visit this group at
http://groups.google.com/group/google-help-dataapi?hl=en
-~----------~----~----~----~------~----~------~--~---
