Print this Page

 

<<Back to Index

FuseTalk Elements

 

Attachment

AuthorIcon

Ban

Category

CensorWord

Country

DictionaryDetail

DictionaryWord

Emoticon

Favorite

Forum

ftUser

Group

GroupPermission

GroupUser

Log

Message

Poll

PollAnswer

PrivateBanning

PrivateMessage

RatingIcon

Security

 

Settings

State

Subscription

SurveyAnswer

SurveyQuestion

SurveyResponse

Theme

TimeZone

Today

Topic

UserTitle

 

Attachment

This element represents an attachment.

 

Parameters

Name

Type

Description

FileName

String

The path and filename of the attachment.

FileSize

Integer

The size of the file in bytes.

ID

Integer

The ID of the attachment.

InsertDate

DateTime

The date the attachment was inserted.

MessageID

Integer

The ID the attachment is tagged to.

UserID

Integer

The ID of the user the attachment belongs to.

 

Related Items

GetAttachmentsForUser, GetMessageAttachments

 

 

AuthorIcon

This element represents one author icon.

 

Parameters

Name

Type

Description

DefaultVal

String

This value determines if the icon is the default icon when a user is inserted.

IconFileName

String

The filename of the author icon.

IconID

Integer

The ID of the author icon.

IconName

String

The name of the author icon.

Status

String

The status of the icon. The values are "Enabled" or "Disabled".

 

Related Items

???, ???

 

 

Ban

This element represents one single ban item.

 

Parameters

Name

Type

Description

BanID

Integer

The ID of the ban item.

BanReason

String

The reason the ban item was inserted into FuseTalk.

BanString

String

The IP Address, Username or E-mail Address string that is banned.

ForumID

Integer

The ID of the forum the ban item is attached to. If the ban is global the forum ID will be 0.

Type

String

The type of ban (IP = IP Address, UN = Username, EM = E-mail Address).

 

Related Items

GetBanByKeyword, GetBanByID, GetBanByType

 

 

Category

This element represents a category within FuseTalk.

 

Parameters

Name

Type

Description

AllowAttachments

String

Allow Attachments. (Yes, No)

AllowCode

String

Allow users to attach pre-formatted code to their messages. (Yes, No)

AllowRating

String

Allow message rating. (Yes, No)

Approval

String

Approve all topics and messages in the category. (Yes, No)

CategoryDesc

String

The description of the category.

CategoryID

Integer

The ID of the category.

CategoryName

String

The name of the category.

CategoryNotice

String

The category notice of the category.

CategoryStatus

String

The status of the category (active = Post and Reply, read = Read Only, hide = Hidden, locked = Locked; lockedread = Locked Read Only, protected = Password Protected, reply = Reply Only, login = Login Only)

CategoryURL

String

The URL to re-direct the category.

CatGroupNum

Integer

The order of the category when listed in FuseTalk.

ErrorCode

Integer

False

ForumID

String

The ID of the forum the category belongs to.

HeaderID

Integer

The parent of the category (if HeaderID is 0, the category at the top-level).

HTML

String

This value determines if HTML is allowed in category posts. (Yes, No)

LastMsgDate

DateTime

The date of the last message which was posted in the category.

LastPoster

String

The username of the user who last posted to the category.

MsgLimit

String

This value determines if the message limit will be taken under consideration. (Yes, No)

MsgLimitNum

Integer

The maximum number of messages allowed to be posted in a topic.

NNTPGroup

String

False

Password

String

The password of the category (only used when category status is protected).

SupportAnswer

String

False

SurveyUsage

Integer

False

ThreadCount

Integer

The number of topics in the category.

ViewUserMsgOnly

Integer

This value determines if the user views only his topics when they enter a category. (1 = Yes, 0 = No)

 

Related Items

CreateCategory, IsCategory, GetAllCategories, GetAllForumCategories, GetAvailableSubCategories, GetCategories, GetPrivateMessageCategories

 

 

CensorWord

This element represents a censored word.

 

Parameters

Name

Type

Description

ForumID

Integer

The forum ID the word belongs to. If the forum ID is 0 the word is globally censored.

Word

String

The word which was censored.

WordID

Integer

The ID of the censored word.

 

Related Items

GetCensorWords

 

 

Country

This element represents a country.

 

Parameters

Name

Type

Description

CountryCode

String

The country code of the country.

CountryID

Integer

The ID of the country.

CountryName

String

The name of the country.

 

Related Items

GetCountryByID, GetCountries

 

 

DictionaryDetail

This element represents a dictionary.

 

Parameters

Name

Type

Description

DateFormat

String

The default date format of the dictionary.

DictionaryID

Integer

The ID of the dictionary.

DictionaryName

String

The name of the dictionary.

Locale

String

false

TimeFormat

String

The default time format of the dictionary.

 

Related Items

???, ???

 

 

DictionaryWord

This element represents a dictionary word.

 

Parameters

Name

Type

Description

DictionaryID

Integer

The dictionary ID the word belongs to.

SectionName

String

The section of the dictionary the word belongs to.

Word

String

The string value of the word.

WordID

Integer

The ID of the dictionary word.

 

Related Items

GetDictionaryForForum

 

 

Emoticon

This element represents an emoticon.

 

Parameters

Name

Type

Description

EmoticonID

Integer

The ID of the emoticon.

EmoticonReplace

String

The value the EmoticonString will be replaced with <img src="smiley.gif">

EmoticonString

String

The string value that represents the emoticon ( :D )

EmoticonTitle

String

The title of the emoticon (Smiley)

ForumID

Integer

False

 

Related Items

GetEmoticonByID, GetAllEmoticons

 

 

Favorite

This element represents a user's favorite topic.

 

Parameters

Name

Type

Description

CategoryID

Integer

The category ID the topic ID belongs to.

CategoryName

String

The Category name of the CategoryID.

Description

String

The description of the favorite.

ID

Integer

The ID of the favorite.

Prefix

String

This value determines is the topic is archived. (arc = the topic is archived).

ThreadID

Integer

The topic ID of the favorite.

UserID

Integer

The user ID that the favorite belongs to.

 

Related Items

GetAllFavoritesByUser, GetFavorites

 

 

Forum

This element represents a forum.

 

Parameters

Name

Type

Description

AuthorIcon

String

False

CompanyURL

String

The URL of the company who owns the forum.

ErrorCode

Integer

False

ExpiryDate

DateTime

The date the forum expires.

ForumKey

String

False

ForumURL

String

The url of the forum (http://www.mycompany.com/fusetalk/forum/default.aspx).

ID

Integer

The ID of the forum.

InsertDate

DateTime

The date the forum was inserted.

MaxCategories

Integer

The maximum number of categories which can be added to the forum.

MaxThreads

Integer

The maximum number of topics a category can have.

MaxUsers

Integer

The maximum number of users a forum can have.

MessagePostCount

Integer

The total number of messages that was posted in the forum.

Name

String

The name of the forum.

Notes

String

The notes associated with the forum.

ThreadCount

Integer

The total number of topics that was posted in the forum.

UserType

String

The type of forum (fs = stand-alone, g = global).

 

Related Items

GetForumByCategoryID, GetForumByName, GetForumByID, GetAllForums, SearchForumsByCriteria, SearchForumsByAlphabet, GetForumsForUser

 

 

ftUser

This element represents a User.

 

Parameters

Name

Type

Description

AllowRating

Integer

This value determines if the user wants to be rated from 1 to 10 by other users. (0 = Yes, 1 = No)

Approved

Integer

This value determines if the user has been approved. (1 = Yes, 0 = No)

AuthorIcon

String

The author icon of the user.

Bandwidth

Integer

False

BirthDate

DateTime

The birth date of the user.

BlockSig

Integer

This value determines if the user wants to block other users signatures. (0 = No, 1 = Yes)

CategoryBlock

String

A listing of the categories the user wants to block.

CategoryPerms

String

The list of categories a user is allowed to see.

CategorySubscription

String

False

ChatAllow

Integer

False

City

String

The city the user lives in.

CountryID

Integer

The ID of the country the user lives in.

CustomIcon

String

The custom author icon of the user (used when users can upload their own icons).

DaysBack

Integer

False

DefaultForumView

String

The default view the user prefers.

DictionaryID

Integer

The ID of the preferred dictionary of the user.

DisplayName

String

The current display name of the user (Different when Full name or Username display is selected).

EmailAddress

String

The e-mail address of the user.

EmailAvailable

Integer

This value determines if the user's e-mail address is to be disabled. (0 = Yes, 1 = No)

ErrorCode

Integer

False

ErrorInfo

String

False

ExpiryDate

DateTime

The date the user expires.

FirstName

String

The first name of the user.

ID

Integer

The ID of the user.

InsertDate

DateTime

The date the user was inserted.

IPAddress

String

The last known IP Address of the user.

isActive

Integer

False

isLoggedIn

Boolean

This value determines if a user is logged in.

LastName

String

The last name of the user.

LastVisitedCatID

Integer

False

LastVisitedDate

DateTime

The date the user last visited FuseTalk.

MessagePostCount

Integer

The number of messages the user posted.

MessagesPerPage

Integer

This value determines the amount of messages per page a user wants to read.

MsgAllow

Integer

This value determines if the user is allowed to received private messages. (0 = No, 1 = Yes)

MsgOrder

String

This value determines which order the messages are to be displayed in (asc = Ascending, desc = Descending)

NoPrivateInvites

Integer

False

Notes

String

The notes associated with the user.

OverrideTitle

Integer

This value determines if the user's title was overwritten. (0 = No, 1 = Yes)

Password

String

The password of the user (If security is turned on, the password will be encrypted).

QuickReply

String

False

Rating

String

False

RatingCount

Integer

The average rating of a user.

SecretAnswer

String

The answer to the secret question.

SecretQuestion

Integer

The ID of the secret question (The ID refers to a word ID from the dictionary)

SecurityPermissions

String

The list of security permissions associated with a user.

SideMenu

Integer

This value determines if the user has the side menu turned on or off. (0 = No, 1 = Yes)

Signature

String

The signature of the user.

StateID

String

The ID of the state the user lives in.

Status

Integer

The status of the user (0 = Enabled, 1 = Disabled).

SubChoice

Integer

This value determines what type of subscription the user would like receive. (1 = Private Message, 0 = E-Mail)

this

for

False

ThreadsPerPage

Integer

This value determines the amount of topics per page a user wants to read.

TimeOutDate

DateTime

False

TimeZoneDiff

String

The number of hours different from Greenwhich standard time.

TimeZoneID

Integer

The ID of the time zone the user lives in.

TombstoneAvailable

Integer

This value determines if the user profile is public. (0 = Yes, 1 = No)

TotalPostCount

Integer

The total number of messages a user posted across all forums.

Type

String

The type of user (fs = Stand-Alone User, g = Global User).

UserEditor

String

False

UserLevel

Integer

The user level of the user (0 = user can login to the global admin, 1 the user can't login to the global admin).

Username

String

The username of the user.

UserTheme

Integer

The ID of the theme the user prefers.

WebURL

String

The url of the user's website.

Welcome

Integer

False

 

Related Items

GetForumBuddies, GetDigestSubs, GetForumPermissions, GetMessageAuthor, GetThreadAuthor, GetUserByKeyword, GetUserByEmail, GetNonApprovedUsers, LoginUser, LoginUser, GetTodayBirthDate, GetUserByName, GetUserByID, GetUserSettings, LoginGlobal, AddUser, AddUser, SearchUsersByAlphabet, SearchUsersByCriteria, SearchUsersByIPAddress

 

 

Group

This element represents a group.

 

Parameters

Name

Type

Description

ForumID

Integer

The ID the group is associated to (If the ForumID is 0 the group is global).

ID

Integer

The ID of the group.

Name

String

The name of the group.

Security

String

The security permissions associated with the group.

 

Related Items

GetGroups, GetGroup

 

 

GroupPermission

This element represents a groups security association with category. The groups associated with the category, belong to the categories security structure.

 

Parameters

Name

Type

Description

CategoryID

Integer

The category ID the group security is associated with.

Group

Group

A group object associated with the group/category security structure.

Type

String

False

UserID

Integer

False

 

Related Items

GetGroups, GetGroup

 

 

GroupUser

This element represents a user and one of the group he belongs to.

 

Parameters

Name

Type

Description

ftUser

ftUser

The user that is associated with the group.

GroupID

Integer

The ID of the group.

 

Related Items

GetGroupUsers

 

 

Log

This element represents a log entry of the moderator logs.

 

Parameters

Name

Type

Description

InsertDate

DateTime

The date the log entry was inserted.

IPAddress

String

The IP address of the user who performed the action which caused the log entry.

LogID

Integer

The ID of the log entry.

LogText

String

The description of the log entry.

NickName

String

The username of the user who is associated with the log entry.

UserID

Integer

The ID of the user associated with the log entry.

 

Related Items

GetLogs

 

 

Message

This element represents a FuseTalk message.

 

Parameters

Name

Type

Description

Approved

String

This value determines if the message was approved. (Yes, No)

AttachCount

Integer

The number of attachments the message contains.

AuthorIcon

String

False

CategoryID

Integer

The category ID the TopicID belongs to.

ChatRequest

Integer

False

City

String

False

Code

String

The pre-defined code asssociated with the message.

CustomIcon

Integer

False

EditMessage

String

False

ErrorCode

Integer

False

FirstName

String

False

ICQ

String

False

ID

Integer

The ID of the message.

IPAddress

String

The IP Address of the user who posted the message.

LastName

String

False

LastPoster

String

False

LastVisitDate

DateTime

False

Layer

Integer

False

MessageAllow

Integer

False

MessageDate

DateTime

The date the message was inserted.

MessagePostCount

Integer

False

MessageText

String

The body of the message.

MessageTitle

String

The title of the message.

NNTPID

String

False

ParentID

Integer

The message ID of the parent message (this value is used to determine the parent/child relationship of messages when constructing the tree).

RatingIcon

String

The rating icon associated with the message.

Signature

String

False

ThreadID

Integer

The topic ID the message is associated with.

Title

String

False

Tombstone

Integer

False

Type

String

False

UserID

Integer

The ID of the user who posted the message.

UserInsertDate

DateTime

False

UserName

String

False

VideoRequest

Integer

False

WhiteRequest

Integer

False

 

Related Items

GetNewMessagesForDigest, GetNonApprovedMessages, PostMessage, GetArcMessagesByThreadID, GetMessagesByThreadID, GetMessageByID

 

 

Poll

This element represents a poll question.

 

Parameters

Name

Type

Description

Description

String

The text question of the poll.

ForumID

Integer

The forum ID the poll is associated with.

ID

Integer

The ID of the poll.

InsertDate

DateTime

The date the poll was inserted.

ParentID

Integer

The parent ID of the poll. (if the poll belongs to a topic the parent ID will be the topic ID, otherwise the parent ID will be the forum ID)

PollType

String

The type of poll (thread = Topic poll, forum = Forum poll).

UserID

Integer

The ID of the user who created the poll.

 

Related Items

GetPoll

 

 

PollAnswer

This element represents an answer to a poll question.

 

Parameters

Name

Type

Description

Answer

String

The text answer.

Count

Integer

The number of times the answer was chosen.

ID

Integer

The ID of the poll answer.

PollID

Integer

The poll ID the answer belongs to.

 

Related Items

GetPollAnswer, GetPollAnswers

 

 

PrivateBanning

This element represents a privately banned user. User's who ban others will not receive any private messages from them.

 

Parameters

Name

Type

Description

ID

Integer

The ID of the private ban.

Nickname

String

The username that was banned.

UserID

Integer

The user ID that ban belongs to.

 

Related Items

GetPrivateBanning

 

 

PrivateMessage

This element represents a private message.

 

Parameters

Name

Type

Description

ID

Integer

The ID of the private message.

InsertDate

DateTime

The date the private message was inserted.

Message

String

The message body of the private message.

MessageType

String

The type of the private message (Nor = normal message)

Notified

String

False

OwnerID

Integer

The user if that owns the private message.

SenderDictionaryID

Integer

False

SenderFirstName

String

False

SenderID

Integer

The ID of the user who sent the private message.

SenderLastName

String

False

SenderTombstone

Integer

False

SenderUserName

String

False

Status

String

The status of the private message (read = Message has been read, unread = message was not read)

UsageStatus

String

The folder the private message belongs to.

UserDictionaryID

Integer

False

UserFirstName

String

False

UserLastName

String

False

UserTombstone

Integer

False

UserUserName

String

False

 

Related Items

ReadPrivateMessage, GetPrivateMessageHistory, GetPrivateHistoryByUser, GetPrivateMessages

 

 

RatingIcon

This element represents a rating icon.

 

Parameters

Name

Type

Description

RatingIconFile

String

The filename of the rating icon.

RatingIconID

Integer

The ID of the rating icon.

RatingIconName

String

The name of the rating icon.

 

Related Items

GetRatingIcons, GetRatingIconByID

 

 

Security

This element represents a security descriptor.

 

Parameters

Name

Type

Description

ID

Integer

The ID of the security descriptor.

Type

String

The type of security descriptor (m = moderator level security, a = administration level security, c = category level security)

WordID

Integer

The word ID that is associated with the security descriptor.

 

Related Items

GetSecurityDesc

 

 

Settings

This element represents a FuseTalk setting. FuseTalk settings are used in various situations including Forum Settings and Community Settings.

 

Parameters

Name

Type

Description

Name

String

The name of the setting.

Perm

String

False

Type

String

False

Value

String

The value of the setting.

 

Related Items

GetDefaultCommunitySettings, GetForumSettings

 

 

State

This element represents a state.

 

Parameters

Name

Type

Description

Country

String

The country ID the state is associated with.

State

String

The name of the state.

StateID

Integer

The ID of the state.

 

Related Items

GetStateByID, GetStates

 

 

Subscription

This element represents a subscription entry for FuseTalk.

 

Parameters

Name

Type

Description

CategoryID

Integer

False

ID

Integer

The ID of the subscription.

LastMsgDate

DateTime

False

MessageCount

Integer

False

ResourceID

Integer

The ID of the category or topic the subscription is associated with.

ResourceName

String

The name of the category or topic.

Type

String

The type of subscription (cat = category level subscription, thread = thread level subscription; dig = digest subscription)

UserID

Integer

The ID of the user who owns the subscription.

 

Related Items

GetUserSubscriptions, CheckSubscriptionByThread, GetAllUserSubscriptions

 

 

SurveyAnswer

This element represents a survey answer.

 

Parameters

Name

Type

Description

Answer

String

The text of the answer.

AnswerID

Integer

The ID of the answer.

QuestionID

Integer

The ID of the question the answer is associated with.

 

Related Items

SurveyGetAnswerByID, SurveyGetAnswers

 

 

SurveyQuestion

This element represents a survey question.

 

Parameters

Name

Type

Description

CategoryID

Integer

The ID of the category the survey is associated with.

ForumID

Integer

The ID of the forum the survey is associated with.

ID

Integer

The ID of the survey question.

Question

String

The text of the question.

Required

Integer

This value determines if the question is required (Yes, No).

Type

String

The type of question (DD = Drop Down, FT = Free Text).

 

Related Items

SurveyGetQuestionByID, SurveyGetQuestions

 

 

SurveyResponse

This element represents a survey response.

 

Parameters

Name

Type

Description

AnswerID

Integer

The ID of the answer the response is associated with.

CategoryID

Integer

The ID of the category the question is associated with.

ForumID

Integer

The ID of the forum the question is associated with.

FreeText

String

The free text value (this value is blank if the type of question is a drop down).

QuestionID

Integer

The ID of the question the response is associated with.

UserID

Integer

The ID of the user who responded to a survey.

 

Related Items

SurveyGetResponses

 

 

Theme

This element represents a theme.

 

Parameters

Name

Type

Description

DefaultShade

String

The default shade of a theme (Light = Light background, Dark = Dark Background)

DirName

String

The directory the theme is contained in.

ID

Integer

The ID of the theme.

Name

String

The name of the theme.

StyleSheet

String

The name of the stylesheet (including the .css extension).

 

Related Items

GetThemes, GetThemeByID

 

 

TimeZone

This element represents a time zone.

 

Parameters

Name

Type

Description

Description

String

The description for the timezone.

Difference

String

The number of hours different from Greenwich standard time.

Order

Integer

False

TimeZoneID

Integer

The ID of the timezone.

 

Related Items

GetTimeZones, GetTimeZoneByID

 

 

Today

This element represents a today item.

 

Parameters

Name

Type

Description

ForumID

Integer

The ID of the forum the today item belongs to.

TodayDate

DateTime

The date the today item was posted.

TodayID

Integer

The ID of the today item.

TodayText

String

The body of the today item.

TodayTitle

String

The title of the today item.

 

Related Items

GetToday, GetTodayItemByID

 

 

Topic

This element represents a topic.

 

Parameters

Name

Type

Description

AlertThread

String

This value determines if the topic needs to remain on top of the topic listing

AnswerDate

DateTime

The date the topic was answered.

AnswerMsgID

Integer

The ID of the message which was the answer.

AnswerPersonID

Integer

The ID of the person who answered the topic.

Approved

String

This value determines if the topic has been approved (Yes, No)

Archived

String

False

CategoryID

Integer

The ID the topic belongs to.

CategoryName

String

False

CategoryStatus

String

False

ErrorCode

Integer

False

FirstName

String

False

ID

Integer

The ID of the topic.

InsertDate

DateTime

The date the topic was inserted.

LastMsgDate

DateTime

The date the last message was posted.

LastName

String

False

LastPoster

String

The username of the user who last posted a message in the topic.

Message

String

False

MessageCount

Integer

The number of messages in the topic.

MessageDate

DateTime

False

MessageID

Integer

False

MessageTitle

String

False

NickName

String

False

PollFlag

String

False

PrivateTopic

Integer

This value determines if the topic is private or not (0 = Not Private, 1 = Private)

RatingIcon

String

The icon of the topic rating.

Status

String

False

StayDate

DateTime

This value determines the amount of time the topic needs to remain on top of the topic listing.

ThreadLock

String

This value determines if the thread is locked (Yes, No)

ThreadName

String

The title of the topic.

TopicSummary

String

The summary of the topic.

UserID

Integer

The ID of the user who posted the topic.

UserMessagePostCount

Integer

False

UserTombStone

Integer

False

ViewCount

Integer

The number of times the topic was viewed.

 

Related Items

GetLastestMessages, GetHotMsg, SearchMessages, GetNonApprovedThreads, GetThreadByID, GetThreads, IsThread

 

 

UserTitle

This element represents a user title.

 

Parameters

Name

Type

Description

ForumID

Integer

The forum ID the title is associated with. If the forum ID is 0, the title is used as the default for global forums.

MinCount

Integer

The minimum amount of messages a user need to get this title.

Title

String

The text of the title.

 

Related Items

GetTitleByName, GetAllUserTitles