Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

ipboard

Package Overview
Dependencies
Maintainers
1
Versions
4
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

ipboard

A client library for making XML-RPC requests to Invision Power Board

  • 0.0.2-2
  • latest
  • Source
  • npm
  • Socket score

Version published
Maintainers
1
Created
Source

#IpBoard

A client library for making XML RPC requests to ipboard with Node.js.

##Usage

var ipboard = require('ipboard');

var client = new ipboard({
  encoding: 'utf8',
  api_key: 'yoursecretkey',
  host: 'yourawesomeforum.com',
  port: 80,
  path:'/community/interface/board/index.php' //Only need to set if different from standard /interface/board/index.php
});

client.fetchTopics({
  forum_ids: '16',
  order_field: 'post_date',
  order_by: 'desc',
  offset: '0',
  limit: '10',
  view_as_guest: false
}, function(err, results){
  //Good job!
});

##Methods Available

For complete IP.Board API info visit: http://www.invisionpower.com/support/guides/_/advanced-and-developers/api-methods/xml-rpc-api-r62

postTopic(options, cb)

Params:

options = {
    member_field: String,
    member_key  : String,
    forum_id    : String,
    topic_title : String,
    post_content: String
  }

postReply(options, cb)

Params:

options = {
  member_field: String,
  member_key  : String,
  topic_id    : String,
  post_content: String
}

fetchMember(options, cb)

Params:

options = {
  search_type   : String,
  search_string : String
}

checkMemberExists(options, cb)

Params:

options = {
  search_type   : String,
  search_string : String
}

fetchOnlineUsers(cb)

Params: None

fetchForumsOptionList(cb)

Params: None

fetchForums(options, cb)

Params:

options = {
  forum_ids: String // comma separated list
}

fetchTopics(options, cb)

Params:

options = {
  forum_ids: String, // comma separated list
  order_field: String,
  order_by: String, // asc|desc
  offset: Number,
  limit: Number,
  view_as_guest: Number // 0 for false, 1 for true
}

fetchStats(cb)

Params: None

helloBoard(cb)

Params: None

customFunction(functionName, options, cb)

Params:

functionName = 'the string of the function name you created'
options = {
  //Whatever options you should be passing
}

##License MIT


#####Made with love by @taterbase

Keywords

FAQs

Package last updated on 01 Mar 2013

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc