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

Returns the events for a date range based on event type selection.

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

Syntax

C#
public DataSet GetEvents(
	DateTime startDateTime,
	DateTime endDateTime,
	GroupSelection eventType,
	TimeZoneInfo userTzInfo,
	TimeZoneInfo serverTzInfo,
	int userId,
	int groupId
)
Visual Basic (Declaration)
Public Function GetEvents ( _
	startDateTime As DateTime, _
	endDateTime As DateTime, _
	eventType As GroupSelection, _
	userTzInfo As TimeZoneInfo, _
	serverTzInfo As TimeZoneInfo, _
	userId As Integer, _
	groupId As Integer _
) As DataSet
Visual C++
public:
DataSet^ GetEvents(
	DateTime startDateTime, 
	DateTime endDateTime, 
	GroupSelection eventType, 
	TimeZoneInfo^ userTzInfo, 
	TimeZoneInfo^ serverTzInfo, 
	int userId, 
	int groupId
)

Parameters

startDateTime
Type: System..::.DateTime
Start date and time of the range.
endDateTime
Type: System..::.DateTime
End date and time of the range.
eventType
Type: OfficeClip.Utils..::.GroupSelection
Type of event whether all group events (where the user belongs), currently selected group's events or private events.
userTzInfo
Type: OfficeClip.Utils..::.TimeZoneInfo
The user timezone information.
serverTzInfo
Type: OfficeClip.Utils..::.TimeZoneInfo
The server timezone information.
userId
Type: System..::.Int32
The unique id of the user.
groupId
Type: System..::.Int32
The unique id of the group.

Return Value

DataSet containing all the event related information. The DataSet contains a single table with following columns.
  • eventId (System.Int32) Id of a particular event.
  • eventName (System.String) Name of the event.
  • groupName (System.String) Name of the group for which this event is created. It will have a null value when a particular event is a private event.
  • startWeekDay (System.Int32) Day of the week when the event starts.
  • sartDay (System.Int32) Day of the month when the event starts.
  • isPrivate (System.String) Flag (Y/N) indicating whether this event is a private event or not.
  • startDateTime (System.DateTime) Date and Time when the event starts.
  • startHour (System.Int32) Hour when the event starts.
  • startMinute (System.Int32) Minute when the event starts.
  • startTime (System.String) Time at which the event starts.
  • endDateTime (System.DateTime) Date and Time when the event ends.
  • endTime (System.String) Time at which the event ends.
  • odtm (System.Int32) Duration in minutes which the day light saving time offset depending on the timezone of Current logged in user and the timezone for which the event was created.
  • location (System.String) location of the event.
  • url (System.String) Url of the event.
  • createdDateTime (System.DateTime) Date and Time when this event was created.
  • description (System.String) The description of the event.

See Also