[This is preliminary documentation and is subject to change.]

Gets all the upcoming events for a particular user in a particular group (applicable only if event type selected is groupType) from the database based on the type of event selected.

Namespace:  OfficeClip.DBLayer.Desktop
Assembly:  OfficeClip.DBLayer (in OfficeClip.DBLayer)
Version: 8.1.1.0

Syntax

C#
public DataSet GetUpcomingEvents(
	int userId,
	int groupId,
	GroupSelection eventType
)
Visual Basic (Declaration)
Public Function GetUpcomingEvents ( _
	userId As Integer, _
	groupId As Integer, _
	eventType As GroupSelection _
) As DataSet
Visual C++
public:
DataSet^ GetUpcomingEvents(
	int userId, 
	int groupId, 
	GroupSelection eventType
)

Parameters

userId
Type: System..::.Int32
The unique id of the user.
groupId
Type: System..::.Int32
The unique id of the group.
eventType
Type: OfficeClip.Utils..::.GroupSelection
The type of events which need to be returned. OfficeClip.Utils..::.GroupSelection

Return Value

DataSet containing all the upcoming event releated information. DataSet contains a single table containing the following columns.
  • eventId (System.Int32) Id of the event.
  • eventName (System.String) Name of the event.
  • EventDescription (System.String) Description of the event.
  • groupName (System.String) Name of the group to which the event belongs if it is a group type event.
  • startDatetime (System.DateTime) Starting Date and Time of the event. (Convert into currently logged in user's timezone)
  • endDatetime (System.DateTime) Ending Date and Time of the event. (Convert into currently logged in user's timezone)
  • isPrivate (System.String) Flag (Y/N) indicating whether event is a group or private event.

See Also