Code Monkey home page Code Monkey logo

lxboardgamegeek's Introduction

LXBoardGameGeek

CI Status Version License Platform

Installation

LXBoardGameGeek is available through CocoaPods. To install it, simply add the following line to your Podfile:

pod "LXBoardGameGeek"
SoonTM

Usage

To run the example project, clone the repo, and run pod install from the Example directory first.

LXBoardGameGeek is created as a singleton (i.e. it doesn't need to be explicitly allocated and instantiated; you directly call [LXBoardGameGeek method]).

Quick example that returns all boardgames that matches "Settlers of catan":

NSArray *options = @[kBGGOptionTypeBoardGame];

[LXBoardGameGeek search:@"Settlers of Catan" options:options completion:^(NSArray *games, NSError *error) {
    if (!error) {
        //Do something with games
    }
}];

###Available endpoints:

+ (void)gameWithID:(int)gameID options:(NSArray *)options completion:(boardGameCompletionBlock)completion;
+ (void)search:(NSString *)name options:(NSArray *)options completion:(boardGamesCompletionBlock)completion;
+ (void)gamesFromArray:(NSArray *)gameIDs options:(NSArray *)options completion:(boardGamesCompletionBlock)completion;
+ (void)gamesFromString:(NSString *)gameIDs options:(NSArray *)options completion:(boardGamesCompletionBlock)completion;

#####Options Every call takes an NSArray with kBGGOptions. These are available right now: ######Search:

  • kBGGOptionTypeBoardGame (Return boardgames only)
  • kBGGOptionTypeExpansion (Return boardgameexpansions only)
  • kBGGOptionSearchExact (Match name exactly)

######gameWithID:

  • kBGGOptionShowStats (Also fetch statistics)

#####LXBoardGame LXBoardGame is the primary model returned by most methods. See LXBoardGame.h for all available properties.

Requirements

LXBoardGameGeek is using XMLDictionary by Nick Lockwood which is included as a CocoaPod.

PR

I would love to receive feedback on this project. Send a PR or shoot me an email.

License

LXBoardGameGeek is available under the MIT license. See the LICENSE file for more info.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.