Print this Page

TODAY Functions

Below is a listing of all the functions.

 

DeleteTodayItem

DeleteTodayItem

This function deletes a today item.

 

Return Type: n/a

 

Name

Type

Description

TodayID

Integer

The ID of the forum.

 

Examples

Visual Basic.Net

'Method DeleteTodayItem

ftObj.DeleteTodayItem(tmpID)

 

C#

//Method DeleteTodayItem

ftObj.DeleteTodayItem(tmpID);

 

GetToday

GetToday

This function retrieves the today records for a forum.

 

Return Type:  Today()

 

Name

Type

Description

ForumID

Integer

The ID of the forum that you want to retrieve the today items for.

Maxrows

Integer

The number of today items you want back.

 

Examples

Visual Basic.Net

'Method GetToday

Dim TodayItems() As Today = ftObj.GetToday(ForumID, 5)

Dim tmpID As Integer

If Not TodayItems Is Nothing Then

    Dim Item As Today

    For Each Item In TodayItems

        MsgBox(Item.TodayTitle)

        tmpID = Item.TodayID

    Next

End If

 

C#

//Method GetToday

FuseTalk.API.Today[] TodayItems = ftObj.GetToday(ForumID, 5);

int tmpID = 0;

if (TodayItems !=  null)

{

foreach (FuseTalk.API.Today Item in TodayItems)

{

Interaction.MsgBox(Item.TodayTitle, 0, null);

tmpID = Item.TodayID;

}

}

 

Related Items

GetTodayItemByID

 

GetTodayItemByID

GetTodayItemByID

 

Return Type:  Today

 

Name

Type

Description

TodayID

Integer

The ID of the today item you want to retrieve.

 

Examples

Visual Basic.Net

'Method GetTodayItemByID

Dim TodayItem As Today = ftObj.GetTodayItemByID(tmpID)

MsgBox(TodayItem.TodayTitle)

 

C#

//Method GetTodayItemByID

FuseTalk.API.Today TodayItem = ftObj.GetTodayItemByID(tmpID);

Interaction.MsgBox(TodayItem.TodayTitle, 0, null);

 

Related Items

GetToday

 

InsertTodayItem

InsertTodayItem

This function inserts a today item for a forum.

 

Return Type: n/a

 

Name

Type

Description

TodayTitle

String

The title of the today item.

TodayText

String

The body of the today item.

ForumID

Integer

The ID of the forum the today item will be inserted for.

 

Examples

Visual Basic.Net

'Method InsertTodayItem

ftObj.InsertTodayItem("This is a today item", "This is the text of the today item", ForumID)

 

C#

//Method InsertTodayItem

ftObj.InsertTodayItem("This is a today item", "This is the text of the today item", ForumID);

 

UpdateTodayItem

UpdateTodayItem

This function updates a today item.

 

Return Type: n/a

 

Name

Type

Description

TodayTitle

String

The title of the today item.

TodayText

String

The body of the today item.

TodayID

Integer

The ID of the today item.

 

Examples

Visual Basic.Net

'Method UpdateTodayItem

ftObj.UpdateTodayItem("Updated Title", "Updated Body", tmpID)

 

C#

//Method UpdateTodayItem

ftObj.UpdateTodayItem("Updated Title", "Updated Body", tmpID);