oracle.discussions.sdk
Class TdSubscription

java.lang.Object
oracle.discussions.sdk.TdSubscription

Direct Known Subclasses:

TdThreadSubscription

public class TdSubscription

extends java.lang.Object

Oracle discussions allows users to subscribe to the discussions elements of their choice, to which they have access to.

Once the element is subscribed by a user, a notification email will be sent to him on any change in that element.
Once created, the subscription remains in place till

• The Subscription is deleted
• The element which is subscribed is deleted
• The User who is requesting the subscription is either deleted or the access to the user on that element is revoked.

Subscriptions allow discussions users to monitor the changes to the discussions elements, without actually logging into the discussions instance.

Sample code snippet to illustrate the usage of TdSubscription

  //tdStore is an instance of TdStore class.
  //Extract the Subscription Manager from teh tdStore instance.
  TdSubscriptionManager tdSbtMgr = tdStore.getSubscriptionManager();
  //Extract subscription on a particulat thread from the subscription manager.
  TdSubscription tdSbt = tdSbtMgr.getSubscription(tdt);//tdt is a thread instance which is subscribed.
  //Extract the subscriber information from the subscription object.
  TdUser tdu = tdSbt.getSubscriber();
 

Since:

OCS 10.1.1

See Also:

TdSubscriptionManager.java

Field Summary

static int	DIGEST Indicates that the notification sent is a forward to the user.
static int	EMAIL Indicates the notification sent is an email to the user.

Constructor Summary

TdSubscription(TdUser usrctx, TdContainer tdc, java.lang.String email, int iType)
Constructor to initialize a TdSubscription taking in TdUser - Oracle Discussions user requesting subscription TdContainer - Container on which subscription is being requested email - Email Address to which the notifications should be sent iType - The Subscription type

Method Summary

java.lang.String	getEmail() Returns the email address of the user requesting subscription.
TdUser	getSubscriber() Returns the user requesting the subscription.
TdContainer	getTdContainer() Returns the container on which the subscription is requested.
int	getType() Returns the subscription type for the current subscription.
void	setEmail(java.lang.String email) Sets the email address of the user requesting subscription.
void	setSubscriber(TdUser usrctx) Sets the user requesting the subscription.
void	setTdContainer(TdContainer tdc) Sets the container on which the subscription is being requested.
void	setType(int iType) Sets the subscription type for the current subscription.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EMAIL

public static final int EMAIL

Indicates the notification sent is an email to the user.

See Also:

Constant Field Values

DIGEST

public static final int DIGEST

Indicates that the notification sent is a forward to the user.

See Also:

Constant Field Values

Constructor Detail

TdSubscription

public TdSubscription(TdUser usrctx,
                      TdContainer tdc,
                      java.lang.String email,
                      int iType)

Constructor to initialize a TdSubscription taking in

• TdUser - Oracle Discussions user requesting subscription
• TdContainer - Container on which subscription is being requested
• email - Email Address to which the notifications should be sent
• iType - The Subscription type

• Parameters:

  tdc - Container on which subscription is being requested

  email - Email Address to which the notifications should be sent

  iType - The Subscription type

  Method Detail

  getSubscriber

  public TdUser getSubscriber()
  

  Returns the user requesting the subscription.

  Returns:

  TdUser the tduser requesting subscription.

  setSubscriber

  public void setSubscriber(TdUser usrctx)
  

  Sets the user requesting the subscription.

  Parameters:

  usrctx - the tduser requesting subscription.

  getTdContainer

  public TdContainer getTdContainer()
  

  Returns the container on which the subscription is requested.

  Returns:

  TdContainer the tdcontainer on which the subscription is requested.

  setTdContainer

  public void setTdContainer(TdContainer tdc)
  

  Sets the container on which the subscription is being requested.

  Parameters:

  tdc - the tdcontainer on which the subscription is being requested.

  getEmail

  public java.lang.String getEmail()
  

  Returns the email address of the user requesting subscription.

  Returns:

  String email address of the user requesting subscription

  setEmail

  public void setEmail(java.lang.String email)
  

  Sets the email address of the user requesting subscription.

  Parameters:

  email - email address of the user requesting subscription

  getType

  public int getType()
  

  Returns the subscription type for the current subscription.

  Returns:

  int integer representing the subscription type.

  setType

  public void setType(int iType)
  

  Sets the subscription type for the current subscription.