hkellaway / Hnkwordlookup
HNKWordLookup
HNKWordLookup is a Cocoapod that performs standard English-language dictionary queries, such as definitions, pronunciations, random words, and Word of the Day.
Communication
- If you have found a bug, and can provide steps to reliably reproduce it, open an issue.
- If you have a feature request, open an issue.
- If you want to contribute, submit a pull request.
Getting Started
- Download HNKWordLookup and try out the included iOS example app
- Check out the documentation for a more comprehensive look at the classes available in HNKWordLookup
Installation with CocoaPods
CocoaPods is a dependency manager for Objective-C, which automates and simplifies the process of using 3rd-party libraries like HNKWordLookup in your projects. CocoaPods is the preferred way to incorporate HNKWordLookup in your project; if you are unfamiliar with how to install CocoaPods or how create a Podfile, there are many tutorials online.
Podfile
platform :ios, '7.0'
pod "HNKWordLookup", "~> 1.1"
API Key
HNKWordLookup uses the Wordnik API to lookup information. You will need a Wordnik API key in order to use HNKWordLookup.
Classes
HNKLookup
HNKWordDefinition
HNKWordPronunciation
HNKWordOfTheDay
Usage
Setup
Requests cannot be made without first supplying HNKLookup
with your Wordnik API Key (see Getting Started). Once your API key is obtained, you can setup HNKLookup
for use by calling sharedInstanceWithAPIKey
(typically within the AppDelegate
):
[HNKLookup sharedInstanceWithAPIKey:@"YOUR_API_KEY"];
You should replace YOUR_API_KEY
with your Wordnik API key.
Lookups
HNKLookup
is responsible for handling any lookups of information. Once Setup is complete, lookup requests can be made to [HNKLookup sharedInstance]
.
definitions
Looking up [[HNKLookup sharedInstance] definitionsForWord:@"center" completion:^(NSArray *definitions, NSError *error) {
if (error) {
NSLog(@"ERROR: %@", error);
} else {
for (HNKWordDefinition *definition in definitions) {
NSLog(@"%@", definition);
}
}
}];
definitions
with specific partsOfSpeech
Looking up Note: The partsOfSpeech
argument can take any number of HNKWordDefinitionPartOfSpeech
types separated by a |
symbol.
[[HNKLookup sharedInstance] definitionsForWord:@"center"
withPartsOfSpeech:HNKWordDefinitionPartOfSpeechNoun | HNKWordDefinitionPartOfSpeechVerbTransitive
completion:^(NSArray *definitions, NSError *error) {
if (error) {
NSLog(@"ERROR: %@", error);
} else {
for (HNKWordDefinition *definition in definitions) {
NSLog(@"%@", definition);
}
}
}];
pronunciations
Looking up [[HNKLookup sharedInstance] pronunciationsForWord:@"orange" completion:^(NSArray *pronunciations, NSError *error) {
if (error) {
NSLog(@"ERROR: %@", error);
} else {
for (HNKWordPronunciation *pronunciation in pronunciations) {
NSLog(@"%@", pronunciation);
}
}
}];
Looking up a random word
[[HNKLookup sharedInstance] randomWordWithCompletion:^(NSString *randomWord, NSError *error) {
if (error) {
NSLog(@"ERROR: %@", error);
} else {
NSLog(@"%@", randomWord);
}
}];
wordOfTheDay
Looking up the [[HNKLookup sharedInstance] wordOfTheDayWithCompletion:^(HNKWordOfTheDay *wordOfTheDay, NSError *error) {
if (error) {
NSLog(@"ERROR: %@", error);
} else {
NSLog(@"%@", wordOfTheDay);
}
}];
wordOfTheDay
for a specific date
Looking up the [[HNKLookup sharedInstance] wordOfTheDayForDate:[NSDate date] completion:^(HNKWordOfTheDay *wordOfTheDay, NSError *error) {
if (error) {
NSLog(@"ERROR: %@", error);
} else {
NSLog(@"%@", wordOfTheDay);
}
}];
Delegate Methods
Delegate methods are available to classes that implement the HNKLookupDelegate
protocol.
Optional Delegate Methods
(BOOL)shouldDisplayNetworkActivityIndicator
The return value of this method determines whether the activity indicator in the status bar is displayed while HNKLookup
makes network requests. The default is NO
.
To have the activity indicator displayed, the class that implements the HNKLookupDelegate
protocol should include the following method call:
- (BOOL)shouldDisplayNetworkActivityIndicator {
return YES;
}
Credits
HNKWordLookup was created by Harlan Kellaway and uses the Wordnik API.
License
HNKWordLookup is available under the MIT license. See the LICENSE file for more info.