TestsTested | ✗ |
LangLanguage | Obj-CObjective C |
License | MIT |
ReleasedLast Release | Apr 2015 |
Maintained by Harlan Kellaway.
Depends on: | |
AFNetworking | ~> 2.5 |
Mantle | ~> 1.5 |
HNKWordLookup is a Cocoapod that performs standard English-language dictionary queries, such as definitions, pronunciations, random words, and Word of the Day.
platform :ios, '7.0'
pod "HNKWordLookup", "~> 1.1"
HNKWordLookup uses the Wordnik API to lookup information. You will need a Wordnik API key in order to use HNKWordLookup.
HNKLookup
HNKWordDefinition
HNKWordPronunciation
HNKWordOfTheDay
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.
HNKLookup
is responsible for handling any lookups of information. Once Setup is complete, lookup requests can be made to [HNKLookup sharedInstance]
.
definitions
[[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
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
[[HNKLookup sharedInstance] pronunciationsForWord:@"orange" completion:^(NSArray *pronunciations, NSError *error) {
if (error) {
NSLog(@"ERROR: %@", error);
} else {
for (HNKWordPronunciation *pronunciation in pronunciations) {
NSLog(@"%@", pronunciation);
}
}
}];
[[HNKLookup sharedInstance] randomWordWithCompletion:^(NSString *randomWord, NSError *error) {
if (error) {
NSLog(@"ERROR: %@", error);
} else {
NSLog(@"%@", randomWord);
}
}];
wordOfTheDay
[[HNKLookup sharedInstance] wordOfTheDayWithCompletion:^(HNKWordOfTheDay *wordOfTheDay, NSError *error) {
if (error) {
NSLog(@"ERROR: %@", error);
} else {
NSLog(@"%@", wordOfTheDay);
}
}];
wordOfTheDay
for a specific date
[[HNKLookup sharedInstance] wordOfTheDayForDate:[NSDate date] completion:^(HNKWordOfTheDay *wordOfTheDay, NSError *error) {
if (error) {
NSLog(@"ERROR: %@", error);
} else {
NSLog(@"%@", wordOfTheDay);
}
}];
Delegate methods are available to classes that implement the HNKLookupDelegate
protocol.
(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;
}
HNKWordLookup was created by Harlan Kellaway and uses the Wordnik API.
HNKWordLookup is available under the MIT license. See the LICENSE file for more info.