Announcement

Collapse
No announcement yet.

Search Result

Collapse
5 results in 0.0061 seconds.
Keywords
Members
Tags
  • You can also choose from the popular tags.


  • Forum Related Methods

    Forum Related Methods

    forum Return forum homepage related information including: Forums list Forum Notices Notifications of new PM/Visitor Message/Incoming Friend Requests etc. User last visit date and time Active Members Birthday Info Newest Userinfo Registered Members count Online Registered Users count and Guest count Max online count records and its date and time Blog stats Total posts and threads of the forum Upcoming Events list Parameters None. Return An array of following items: header - [Array] The data in forum header. activemembers - [Integer] Active members count. activeusers - [Array] Active members list. birthdays - [Array] A list of members whose birthday is today. forumbits - [Array] A list of forums. It's a Forumbits Array. newuserinfo - [Array] The newest registered user info. numberguest - [Integer] Online guest count. numbermembers - [Integer] Registered members count. numberregistered - [Integer] Online members count. recorddate - [String] The date when there're the most online users. recordtime - [String] The time when there're the most online users. recordusers - [Integer] The max online users count. template_hook.forumhome_wgo_stats - [Array] Forum stats from other products (Like blog) today - [String] Today's date totalonline - [Integer] Online users (guest+members) count. totalposts - [Integer] Total posts of the forum. totalthreads - [Integer] Total threads of the forum. header Structure Example 'header' => array ( 'pmbox' => array ( 'lastvisitdate' => 'Today', 'lastvisittime' => '08:12 AM', ), 'notifications_menubits' => '', 'notifications_total' => '', 'notices' => array ( 0 => array ( 'notice_html' => 'Deleted all the notices to test a bug. Sorry!', '_noticeid' => 13, ), 1 => array ( 'notice_html' => 'If this is your first visit, be sure to check out the <a href="faq.php?" target="_blank"><b>FAQ</b></a> by clicking the link above. You may have to <a href="register.php?" target="_blank"><b>register<...
    See more | Go to post

  • Thread/Post Related Methods

    Thread/Post Related Methods

    forumdisplay Return a list of threads and other related information in a forum. If you get forumpasswordmissing errormessage when calling this method, it means that the forum requires a password to view. Then the client needs to require user to input forum password and call this method again with forumpwdmd5 parameter. Parameters GET (Required) forumid - [Integer] The id of the forum to display to user. GET (Optional) perpage - [Integer] How many threads to show per page. pagenumber - [Integer] The current page number of thread list. daysprune - [Integer] Only show the threads which are updated in daysprune days. The value of "Show threads from the..." option. Possible values: Positive Integer - Show threads from the last x days. -1 - Show threads from the beginning. sortfield - [String] The sort type of the threads. Possible value: title, lastpost, replycount, views, postusername, voteavg, dateline and EMPTY (last post by default). sortorder - [String] Sort order. Possible value: asc and EMPTY. prefixid - [Integer] Prefix id filter for the thread list. GET or POST (Optional) If the forum requires password to view, then client needs to pass the following parameter: forumpwdmd5 - [String] Md5 encrypted password string: md5(userid + plain_password) //Guest's userid is 0 Return response is an array of following items: activeusers - [Array] An array contains a list of Loggedin User List Array. announcebits - [Array] A list of announcements in the forum. It contains a list of announcebit array which contains the following items: announcement - [Array] Announcement info. Contains: announcementid - [Integer] Announcement ID. title - [String] Announcement title. views - [Integer] The number of views for this announcement. username - [String] The username of the user who posted the announcement. userid - [Integer] The user id of the user who posted the announcement. usertitle - [String] The title of the user who posted the announcement. postdate - [String] The date when the announcement was posted. daysprune - [Integer] The value of "Show threads from the..." option. Possible values: Positive Integer - Show threads from the last x days. -1 - Show threads from the beginning. forumbits - [Array] A list of the sub-forums of current forum. It's a Forumbits Array. foruminfo - [Array] Current forum's information. It's a Foruminfo Array. forumrules - [Array] Forum rules. It's a Forum Rules Array. limitlower - [Integer] limitupper - [Integer] moderatorslist - [Array] A list of current forum's moderators. It's a Moderator List Array. numbergue...
    See more | Go to post

  • Settings (UserCP) Methods

    Settings (UserCP) Methods

    profile_editprofile
    Returns edit profile form related data. Such as birthday and Custom profile fields.

    Parameters
    None.

    Return
    response.HTML is an array of following items:
    • birthdaybit - [Array] The birthday information:
      • birthdate - [String] Birthday.
      • dayselected - [Array] In format dayofbirth=>'selected="selected"'.
      • monthselected - [Array] In format monthofbirth=>'selected="selected"'.
      • year - [Integer] Year of birth.
      • sbselected - [Array] Birthday privacy. In format privacyid=>'selected="selected"'. privacyid has the following possible values:
        • 0 - Hide Age and Date of Birth
        • 1 - Display Only Age
        • 2 - Display Age and Full Date of Birth
        • 3 - Display Only Day and Month of Birth

    • customfields - [Array]
      • required - [Array] Required profile fields. It's a Custom Profile Fields Array.
      • regular - [Array] Optional profile fields. It's a Custom Profile Fields Array.

    bbuserinfo is an array of following items:
    • username - [String] The username of logged-in user.
    • parentemail - [String] The parent email (for COPPA) of logged-in user.
    • usertitle - [String] The user title of logged-in user.
    • homepage - [String] The homepage of logged-in user.
    • icq - [String] The ICQ number of logged-in user.
    • aim - [String] The AIM account of logged-in user.
    • msn - [String] The Windows Live passport of logged-in user.
    • yahoo - [String] The YAHOO! account of logged-in user.
    • skype - [String] The Skype ID of logged-in user.
    • coppauser - [Boolean] Whether the user requires COPPA authentication.

    show is an array of following items:
    • customtitleoption - Whether the logged-in user has permission to custom user title.
    • birthday_readonly - Whether the birthday field is read only.
    • birthday_optional - Whether the birthday field is optional.

    Possible Errors
    • No Permission Errors


    Require Signature
    Yes.

    ###profile_updateprofile
    Update the user's profile.

    Parameters
    POST (Optional)
    • coppauser - [Boolean] True if the user is a COPPA user.
    • parentemail - [String] New parent email for COPPA.
    • aim - [String] New AIM account.
    • yahoo - [String] New YAHOO! account.
    • icq - [String] New ICQ number.
    • msn - [String] New Windows Live passport.
    • skype - [String] New Skype ID.
    • homepage - [String] New homepage.
    • resettitle - [Boolean] Whether to reset custom user title.
    • customtext - [String] New custom user title.
    • day - [Integer] Day of birth.
    • month - [Integer] Month of birth.
    • year - [Integer] Year of birth.
    • showbirthday - [Integer] Birthday privacy. Possible values:
      • 0 - Hide Age and Date of Birth
      • 1 - Display Only Age
      • 2 - Display Age and Full Date of Birth
      • 3 - Display Only Day and Month of Birth

    • userfield - [Array] Values of custom profile fields.

    Return
    If user profile updating is successful, the method will return the following item:
    • response.errormessage.0 - 'redirect_updatethanks' if user profile updating is successful. Other value means an unexpected error happens.

    Possible Errors
    • No Permission Errors

    Require Signature
    Yes.

    ###profile_editpassword
    Return edit email/password form related data.

    Parameters
    None.

    Return
    show is an array of following items:
    • edit_email_field - Whether to show edit email field.
    • password_optional - Whether new password field is optional.

    Possible Errors
    • No Permission Errors


    Require Signature
    Yes.

    ###profile_updatepassword
    Update the user's password.

    Parameters POST (Required) One of t...
    See more | Go to post

  • Tag Management Methods

    Tag Management Methods

    threadtag_manage
    Returns a list of tags of a content item (thread, picture or article).

    Parameters
    GET or POST
    * contenttype - [Integer] Contenttype ID.
    * contentid - [Integer] Content ID. For article, it's article ID. For thread, it's thread ID. For picture, it's picture ID.

    Return

    Response is an array of following items:
    • contentid - [Integer] Content ID. For article, it's article ID. For thread, it's thread ID. For picture, it's picture ID.
    • title - [String] Content title.
    • contenttype - [Integer] Contenttype ID.
    • tags_remain - [String] Remained tags. (The limit of total tags)
    • tag_delimiters - [String] Available tag delimiters besides
    ...
    See more | Go to post

  • Misc Methods

    Misc Methods

    misc_buddylist
    Returns a list of users in logged user's contacts. Group them by online and offline.

    Parameters
    None.

    Return
    Response is an array of following items:
    • offlineusers - [Array] A list of offline buddies. The sub-array contains:
      • buddy - [Array]
        • username - [String] The buddy's username.
        • invisible - [String] The buddy is currently under invisible mode.
        • userid - [String] The buddy's user ID.
        • lastactivity - [String] Last activity path.
        • buddymark - [String] Buddy mark. Should be '+' or an empty string.
        • invisiblemark - [String] Invisible mark. Should be '*' or an empty string.
        • online - [String] Online status. Online or Offline.
        • onlinestatusphrase - [String] Phrase name of current online status.
        • statusicon - [String] Status icon of current
    ...
    See more | Go to post
Working...
X