Plumtree Portal UI  
 

PTOpenerLinks Members

PTOpenerLinks overview

Public Static Methods

GetJSOpenInNewWindow Returns the JS method to open the specified URL in a new window. The common use case is to use this in the onclick attribute of an HTML element.
GetJSOpenInSameWindow Returns the JS method to open the specified URL in the same window. The common use case is to use this in the onclick attribute of an HTML element.
GetOpenerJavascript Returns the Javascript needed by the Common Opener. We add both dynamic script and static script. To provide a set of simpler API methods, some methods in the static script will call methods from the dynamic script. However, the static API will also include methods that don't depend on the dynamic API.
GetOpenerJSURLOverloaded. Returns the JS that will create an URL that opens the specified object. If you choose to exclude the opener mode (using NULL), the default mode for that class will be used. Note that you need to provide both the QS name and value pairs in the OtpQSArgs argument (the extended GetOpenerJSXXX methods do this for you automatically). This is the base GetOpenerJSURL method. Besides the ApplicationBaseURL, the CurrentUserID and the OpenerMode, you will need to provide all of the other information you need to open your object. You must specify all of the other arguments using the QSArgs argument. Note that this JS just generates the URL. You will need to wrap the URL with more JS (such as the GetJSOpenInXXX methods) if you want to do something useful with the URL. Note that you can generate URLS using the GetOpenerURL server methods, and then wrapping those URLS - these GetOpenerJSURL methods are useful primarly for dynamic JS work, or if you don't want to repeat values on the page.
GetOpenerJSURLOpenASOverloaded. Returns the JS that will create an URL that opens the specified activity space. If you choose to exclude the opener mode (using NULL), the default mode for that class will be used. Note that you need to provide both the QS name and value pairs in the OtpQSArgs argument (the extended GetOpenerJSXXX methods do this for you automatically). Note that this JS just generates the URL. You will need to wrap the URL with more JS (such as the GetJSOpenInXXX methods) if you want to do something useful with the URL. Note that you can generate URLS using the GetOpenerURL server methods, and then wrapping those URLS - these GetOpenerJSURL methods are useful primarly for dynamic JS work, or if you don't want to repeat values on the page. Note that the ApplicationBaseURL and CurrentUserID has already been placed on the page and thus do not need to be passed in.
GetOpenerJSURLOpenObjIDOverloaded. Returns the JS that will create an URL that opens the specified object. If you choose to exclude the opener mode (using NULL), the default mode for that class will be used. Note that you need to provide both the QS name and value pairs in the OtpQSArgs argument (the extended GetOpenerJSXXX methods do this for you automatically). Note that this JS just generates the URL. You will need to wrap the URL with more JS (such as the GetJSOpenInXXX methods) if you want to do something useful with the URL. Note that you can generate URLS using the GetOpenerURL server methods, and then wrapping those URLS - these GetOpenerJSURL methods are useful primarly for dynamic JS work, or if you don't want to repeat values on the page. Note that the ApplicationBaseURL and CurrentUserID has already been placed on the page and thus do not need to be passed in.
GetOpenerJSURLOpenUUIDOverloaded. Returns the JS that will create an URL that opens the specified object. If you choose to exclude the opener mode (using NULL), the default mode for that class will be used. Note that you need to provide both the QS name and value pairs in the OtpQSArgs argument (the extended GetOpenerJSXXX methods do this for you automatically). Note that this JS just generates the URL. You will need to wrap the URL with more JS (such as the GetJSOpenInXXX methods) if you want to do something useful with the URL. Note that you can generate URLS using the GetOpenerURL server methods, and then wrapping those URLS - these GetOpenerJSURL methods are useful primarly for dynamic JS work, or if you don't want to repeat values on the page. Note that the ApplicationBaseURL and CurrentUserID has already been placed on the page and thus do not need to be passed in.
GetOpenerURLCreateOverloaded. Returns an URL that brings you to the location for creating an object of the specified class type. The object will be saved in specified folder. By default, the Application Base URL and User ID will be retrieved from the AS owner. If you want to use alternate values, or remove the User ID from the URL, you need to use the base GetOpenerURL method. Additionally, the ParentSpace Name and ID will also be placed onto the URL and these too will be retrieved from the AS. If you want to change the location of the Parent or remove it from the URL, you can use the overloaded method of the same name.
GetOpenerURLCreateExtOverloaded. Returns an URL that brings you to the location for creating an object of the specified class type. The object will be saved in specified folder. By default, the Application Base URL and User ID will be retrieved from the AS owner. If you want to use alternate values, or remove the User ID from the URL, you need to use the base GetOpenerURL method. Additionally, the ParentSpace Name and ID will also be placed onto the URL and these too will be retrieved from the AS. If you want to change the location of the Parent or remove it from the URL, you can use the overloaded method of the same name.
GetOpenerURLOpenObjIDOverloaded. Returns an URL that opens the specified object. If you do not specify the mode to open the object in, the default mode for that class will be used. Opening by ClassID/ObjectID pair is the simplest way. By default, the Application Base URL and User ID will be retrieved from the AS owner. If you want to use alternate values, or remove the User ID from the URL, you need to use the base GetOpenerURL method. Additionally, the ParentSpace Name and ID will also be placed onto the URL and these too will be retrieved from the A aS. If you want to change the location of the Parent or remove it from the URL, you can use the overloaded method of the same name.
GetOpenerURLOpenUUIDOverloaded. Returns an URL that opens the specified object. If you do not specify the mode to open the object in, the default mode for that class will be used. Note that the UUID will be broken down by the Opener based on the UUID plugin. By default, the Application Base URL and User ID will be retrieved from the AS owner. If you want to use alternate values, or remove the User ID from the URL, you need to use the base GetOpenerURL method. Additionally, the ParentSpace Name and ID will also be placed onto the URL and these too will be retrieved from the AS. If you want to change the location of the Parent or remove it from the URL, you can use the overloaded method of the same name.

Protected Static Methods

useFriendlyURLS Checks whether to use friendly URLs or not from the provided arguments.

Public Instance Constructors

PTOpenerLinks Constructor Initializes a new instance of the PTOpenerLinks class.

Public Instance Methods

Equals (inherited from Object)Determines whether the specified Object is equal to the current Object.
GetHashCode (inherited from Object)Serves as a hash function for a particular type. GetHashCode is suitable for use in hashing algorithms and data structures like a hash table.
GetType (inherited from Object)Gets the Type of the current instance.
ToString (inherited from Object)Returns a String that represents the current Object.

Protected Instance Methods

Finalize (inherited from Object)Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
MemberwiseClone (inherited from Object)Creates a shallow copy of the current Object.

See Also

PTOpenerLinks Class | com.plumtree.portaluiinfrastructure.opener Namespace