Print this Page

SUBSCRIPTION Functions

Below is a listing of all the functions.

 

CheckSubscriptionByThread

CheckSubscriptionByThread

This method checks for subscriptions by thread and user ID.

 

Return Type:  Subscription()

 

Name

Type

Description

ThreadID

Integer

The thread ID to get the subscriptions for.

UserID

Integer

The user ID to get the subscriptions for.

 

Examples

Visual Basic.Net

'Method CheckSubscriptionByThread

Subscriptions = ftObj.CheckSubscriptionByThread(TopicID, UserID)

If Not Subscriptions Is Nothing Then

    Dim Subscription As Subscription

    For Each Subscription In Subscriptions

        MsgBox(Subscription.ResourceName)

    Next

End If

 

C#

//Method CheckSubscriptionByThread

Subscriptions =  ftObj.CheckSubscriptionByThread(TopicID, UserID);

if (Subscriptions != null)

{

foreach (FuseTalk.API.Subscription Subscription in Subscriptions)

{

Interaction.MsgBox(Subscription.ResourceName, 0, null);

}

}

 

Related Items

GetUserSubscriptions, GetAllUserSubscriptions

 

DeleteSubByThreadID

DeleteSubByThreadID

This method deletes a subscription by thread and user ID.

 

Return Type: n/a

 

Name

Type

Description

ThreadID

Integer

The thread ID to delete the subscriptions for.

UserID

Integer

The user ID to delete the subscriptions for.

 

Examples

Visual Basic.Net

'Method DeleteSubByThreadID

ftObj.DeleteSubByThreadID(TopicID)

 

C#

//Method DeleteSubByThreadID

ftObj.DeleteSubByThreadID(TopicID);

 

DeleteSubForUserThreadID

DeleteSubForUserThreadID

This method deletes a subscription by thread and user ID.

 

Return Type: n/a

 

Name

Type

Description

ThreadID

Integer

The thread ID to delete the subscriptions for.

UserID

Integer

The user ID to delete the subscriptions for.

 

DeleteUserSubscription

DeleteUserSubscription

Deletes the subscriptions of a user.

 

Return Type: n/a

 

Name

Type

Description

UserID

Integer

The ID of the user who will get their subscriptions deleted.

 

Examples

Visual Basic.Net

'Method DeleteUserSubscriptions

ftObj.DeleteUserSubscriptions(UserID, "thread")

 

C#

//Method DeleteUserSubscriptions

ftObj.DeleteUserSubscriptions(UserID, "thread");

 

DeleteUserSubscriptions

DeleteUserSubscriptions

This method deletes the subscriptions for a user.

 

Return Type: n/a

 

Name

Type

Description

UserID

Integer

The user ID to delete the subscriptions for.

Type

String

The type of subscription to delete, 'thread' for a thread subscription or 'cat' for a category subscription.

 

Examples

Visual Basic.Net

'Method GetUserSubscriptions

Subscriptions = ftObj.GetUserSubscriptions(UserID, ForumID)

If Not Subscriptions Is Nothing Then

    Dim Subscription As Subscription

    For Each Subscription In Subscriptions

        MsgBox(Subscription.ResourceName)

    Next

End If

 

C#

//Method GetUserSubscriptions

Subscriptions =  ftObj.GetUserSubscriptions(UserID, ForumID);

if (Subscriptions != null)

{

foreach (FuseTalk.API.Subscription Subscription in Subscriptions)

{

Interaction.MsgBox(Subscription.ResourceName, 0, null);

}

}

 

GetAllUserSubscriptions

GetAllUserSubscriptions

Get all subscriptions of a user, for all forums.

 

Return Type:  Subscription()

 

Name

Type

Description

UserID

Integer

The ID of the user.

 

Examples

Visual Basic.Net

'Method GetAllUserSubscriptions

Dim Subscriptions() As Subscription = ftObj.GetAllUserSubscriptions(UserID)

If Not Subscriptions Is Nothing Then

    Dim Subscription As Subscription

    For Each Subscription In Subscriptions

        MsgBox(Subscription.ResourceName)

    Next

End If

 

C#

//Method GetAllUserSubscriptions

FuseTalk.API.Subscription[] Subscriptions = ftObj.GetAllUserSubscriptions(UserID);

if (Subscriptions != null)

{

foreach (FuseTalk.API.Subscription Subscription in Subscriptions)

{

Interaction.MsgBox(Subscription.ResourceName, 0, null);

}

}

 

Related Items

GetUserSubscriptions, CheckSubscriptionByThread

 

GetUserSubscriptions

GetUserSubscriptions

Gets all subscriptions for a user of a particular forum.

 

Return Type:  Subscription()

 

Name

Type

Description

UserID

Integer

The ID of the user.

ForumID

Integer

The ID of the forum the subscriptions belong to.

 

Related Items

CheckSubscriptionByThread, GetAllUserSubscriptions

 

InsertSubscription

InsertSubscription

This method inserts a subscription for a user.

 

Return Type: n/a

 

Name

Type

Description

UserID

Integer

The user ID to insert the subscription for.

SubID

Integer

The ID for the thread, or category to subscribe to.

Type

String

The type of subscription, 'thread' for a thread subscription or 'cat' for a category subscription.

 

Examples

Visual Basic.Net

'Method InsertSubscription

ftObj.InsertSubscription(UserID, TopicID, "thread")

 

C#

//Method InsertSubscription

ftObj.InsertSubscription(UserID, TopicID, "thread");

 

SendSubscriptions

SendSubscriptions

This method sends subscriptions to users, by thread and/or category ID for a user of a specific forum.

 

Return Type: Integer

 

Name

Type

Description

ThreadID

Integer

The thread ID to send the subscriptions for.

CategoryID

Integer

The category ID to send the subscriptions for.

UserID

Integer

The user ID to send the subscriptions for.

ForumID

Integer

The forum ID to send the subscriptions for.