Print this Page

CENSORSHIP Functions

Below is a listing of all the functions.

 

AddWord

AddWord

The ID of the forum you wish to check the category with.

 

Return Type: Integer

 

Name

Type

Description

Word

String

The word you wish to censor.

ForumID

Integer

The ID of the forum you add the word in. Enter 0 if you wish to add the word to the global censor list.

 

Examples

Visual Basic.Net

'Method AddWord

ftObj.AddWord("word", ForumID)

ftObj.AddWord("another", ForumID)

 

C#

//Method AddWord

ftObj.AddWord("word", ForumID);

ftObj.AddWord("another", ForumID);

 

CensorCheckText

CensorCheckText

The ID of the forum you add the word to. Enter 0 if you wish to add the word to the global censor list.

 

Return Type: Integer

 

Name

Type

Description

Text

String

The text that you want to check for censored words.

ForumID

Integer

The ID of the forum you wish to pull the list of forums for.

 

Examples

Visual Basic.Net

'Method CensorCheckText

Result = ftObj.CensorCheckText("Are any of these words censored?", ForumID)

If Result <> 0 Then MsgBox(Result)

 

C#

//Method CensorCheckText

Result = ftObj.CensorCheckText("Are any of these words censored?", ForumID);

if (Result != 0)

{

interaction.MsgBox(Result, 0, null);

}

 

GetCensorWords

GetCensorWords

Get a listing of the words for a forum. This function should only be used if you only want the word listing for a specific forum. This function will not grab the global word list.

 

Return Type:  CensorWord()

 

Name

Type

Description

ForumID

Integer

The ID of the forum you wish to pull the list of forums for.

 

Examples

Visual Basic.Net

'Method GetCensorWords

Dim Words() As CensorWord = ftObj.GetCensorWords(ForumID)

If Not Words Is Nothing Then

    Dim word As CensorWord

    For Each word In Words

        MsgBox(word.WordID & ": " & word.Word)

    Next

 

    'Method RemoveWord

    ftObj.RemoveWord(Words(1).WordID, ForumID)

End If

 

C#

//Method GetCensorWords

FuseTalk.API.CensorWord[] Words = ftObj.GetCensorWords(ForumID);

if (Words != null)

{

foreach (FuseTalk.API.CensorWord word in Words)

{

interaction.MsgBox(word.WordID + ": " + word.Word, 0, null);

}

 

//Method RemoveWord

ftObj.RemoveWord(Words[1].WordID, ForumID);

}

 

RemoveWord

RemoveWord

This function removes a word from the censoring word list.

 

Return Type: Integer

 

Name

Type

Description

WordID

Integer

The ID of the word you wish to remove from the list.

ForumID

Integer

The ID of the forum that contains the word you wish to remove. Enter 0 if you wish to add the word to the global censor list.

 

Examples

Visual Basic.Net

'Method GetCensorWords

Dim Words() As CensorWord = ftObj.GetCensorWords(ForumID)

If Not Words Is Nothing Then

    Dim word As CensorWord

    For Each word In Words

        MsgBox(word.WordID & ": " & word.Word)

    Next

 

    'Method RemoveWord

    ftObj.RemoveWord(Words(1).WordID, ForumID)

End If

 

C#

//Method GetCensorWords

FuseTalk.API.CensorWord[] Words = ftObj.GetCensorWords(ForumID);

if (Words != null)

{

foreach (FuseTalk.API.CensorWord word in Words)

{

interaction.MsgBox(word.WordID + ": " + word.Word, 0, null);

}

 

//Method RemoveWord

ftObj.RemoveWord(Words[1].WordID, ForumID);

}