Jump to content
  • 3.1 - Create Topic

    3.1 - Create Topic

    VBScript   Lua

     

    This GSE action creates a new forum topic.

     

    An example call routing script can be found in A.1 - Example: Create Topic.

     

    image.png

     

     

    Configure action parameters

     

    image.png

     

    By double clicking a parameter in the list, you can edit it.

     

    Domain Required

    This is the URL of your IPS community page, for example: https://www.swyxforum.com

     

    APIKey Required

    This is the REST API Key to authenticate against your IPS community. You created it under 1 - Preparations.
    Please make sure that you have configured the endpoint permissions correctly.

     

    Forum Required

    This is the id of the forum you want to create the topic in. You can obtain the id from the address line of your browser when opening the target forum:

    image.png 

     

    Author Required

    This is id of the IPS community user you want to use as author of the new topic. You can obtain the id from the address line of your browser when opening that users' profile page:

     

    image.png

     

    Title Required

    This is the title of the new topic.

     

    Post Required

    This is the text/body of the new topic.

     

    Locked

    Should the new topic be locked? 
    0 - the new topic will be not be locked
    1 - the new topic will be locked, i.e. no user can create new posts into it
    May be omitted. Default: 0  

     

    Hidden

    Should the new topic be visible to all users? 
    0 - the new topic will be visible to all users
    1 - the new topic will be hidden, i.e. only visible to moderators and administrators, and needs approval to become visible
    May be omitted. Default: 0  

     

    Pinned

    Should the new topic be pinned? 
    0 - the new topic will be not be pinned
    1 - the new topic will be pinned and therefore be listed on top of the topic list of the forum

    May be omitted. Default: 0

     

    Featured

    Should the new topic be featured? 
    0 - the new topic will be not be featured
    1 - the new topic will be featured and therefore be listed on "featured topics" lists in the community

    May be omitted. Default: 0

     

     

    Configure action exits

     

    image.png

     

    Exit 0 (Default)

    This exit will be reached when everyhting worked fine and the topic was created. It is recommmended to name this exit "ok" or "created".

     

    Exit 1

    This exit will be reached when there was any kind of problem and no topic has been created. It is recommended to name this exit "failed".

    If you reach this exit you can refer to 3.7 - Trouble Shooting to figure what went wrong.

     

     

     

    Additional return value (as global variable)

     

    g_sIPSLatestCreatedTopicURL (string)

    This global variable holds the URL of the newly created topic after the ok (0) exit has been reached.


     


    Tom Wellige
     Share


     Share




×
×
  • Create New...

Important Information

By using this site, you agree to our Terms of Use and have taken note of our Privacy Policy.
We have placed cookies on your device to help make this website better. You can adjust your cookie settings, otherwise we'll assume you're okay to continue.