1. Add a new app in your Hipmob account. Once this is done, we'll generate a Mobile Key for your app. Remember this - you'll be using it shortly.
2. In the Link Binary with Libraries section of your project's Build Phases you'll need to add the following Framework Dependencies:
   • libicucore.dylib
   • CFNetwork.framework
   • Security.framework
   • Foundation.framework
3. We use Objective-C categories in the Hipmob framework, so you will need to go to your project's Build Settings and add -force_load to the Other Linker Flags field.
4. Download the Hipmob iOS Framework . This includes all the dependencies required (see the Framework Options section for more details).
   Note The Hipmob iOS framework currently only supports iOS 4.3 or higher (the armv7/armv7s architectures). We provide a universal library with support for running the Hipmob code in the simulator as well.
5. Copy the Hipmob framework folder into your project by dragging the hipmob.framework directory into your Xcode project. Make sure you select the "Copy items into destination group's folder (if needed)" option. Once you have done this, open your build phases (under your project's Build Settings screen) and add the resources from inside the framework into the Copy Bundle Resources section: you will need to select the images used for buttons and backgrounds, but NOT the hipmob.h header file.
6. Include the hipmob header wherever you will be creating hipmob viewcontroller.

   #include <hipmob/hipmob.h>

7. Initialize the hipmob view controller with your HIPMOB_KEY from above.

   hipmob *supportvc = [[[hipmob alloc] initWithAppID:HIPMOB_KEY] autorelease];

   You can also initialize with a custom title as well.

   hipmob *supportvc = [[[hipmob alloc] initWithAppID:HIPMOB_KEY andTitle:SUPPORTTITLE] autorelease];

   Finally, you can pass in an NSDictionary with additional user interface settings.

   			  NSMutableDictionary * settings = [NSMutableDicationary dictionaryWithCapacity:5];
   			  [settings setObject:[NSString stringWithFormat:@"How can we help?"] forKey:HIPMOB_SETTING_TEXT_ENTRY_PLACEHOLDER];
   			  hipmob *supportvc = [[[hipmob alloc] initWithAppID:HIPMOB_KEY andTitle:SUPPORTTITLE andSettings:settings] autorelease];
   			

8. Present the hipmob view controller modally.

   [self presentModalViewController:supportvc animated:YES];

   Some examples: WanderPlayer for iPhone and Killa Killa Whale for iPhone
9. And we're complete. Build your app.
Note If you see build errors complaining about CFHTTP or Security then you missed step #2 above: just add in the dependencies in the Link Binary with Libraries section of your project's Build Phases.

• To log into Adium.
• To log into iChat.
• To log into Instantbird.
• To log into imo.
• To log into Pidgin.
• [PENDING] To log into Empathy.
• [PENDING] To log into Xabber.
• [PENDING] To log into Monal.
• If your XMPP client is not listed above, you can login using the username and password with a domain set to hipmob.com.

1. Perform steps #1 through #5 above.
2. Initialize the hipmob subview with your HIPMOB_KEY from above. Please note, it is VERY IMPORTANT: do not, under any circumstances, autorelease or release this object!. Because of the way that subviews work, we will handle this. The hipmob subview will be properly released whenever its parent view is dismissed.

   			  hipmobView * ipadchat = [[hipmobView alloc] initWithAppID:HIPMOB_KEY];
   			

   As before, you can also initialize with a custom title as well.

   			  hipmobView * ipadchat = [[hipmobView alloc] initWithAppID:@HIPMOB_KEY andTitle:@"Support Chat"];
   			

3. Show the hipmob subview whenever you are ready.

   			  ipadchat.view.frame = CGRectMake(self.view.frame.size.height - 345, 50, 320, 240);
   			  [self.view addSubview:ipadchat.view];
   			

   Remember to keep track of the hipmobView and release it when it is no longer in use. You can check if the view is being displayed by checking the readonly displayed property of the object. To help with this you can use the willDismissHipmobView delegate method.
4. And we're complete. Build your app.
Note As before, if you see build errors complaining about CFHTTP or Security then you didn't add the appropriate libraries: just add in the dependencies in the Link Binary with Libraries section of your project's Build Phases.

• Familiarity with iOS development. The embedded framework comes with all the prebuilt includes so you only have to include the Framework Dependencies listed above as you would normally in Xcode.
• TouchJSON and SocketRocket: These are two libraries that we build into our embedded framework. They will collide with with local copies if you are are already using them. If you already use either library, you'll either need to remove them or to use the hipmob-bare embedded framework which will require that you include both of these.
• Hipmob is compatible with apps developed for iOS 4.3 or higher.
• As an administrator, you have to have an XMPP compatible client to connect to our servers (there are a ton of free ones: on Windows we recommend Pidgin, on OSX Adium, on Linux Empathy, on Android Xabber, and on iOS Monal or IMO. If you don't see your platform here we still love you: just reach out to us if you can't find one and we'll work with you to find one that works). Any other standards-compliant XMPP client should just work. We're also working on integration with federated XMPP servers (such as Google Talk and Facebook), and once that is ready you'll be able to use your existing messaging accounts.

iPhone

hipmob *supportvc = [[[hipmob alloc] initWithAppID:HIPMOB_KEY] autorelease];
		      [self presentModalViewController:supportvc animated:YES];

hipmob *supportvc = [[[hipmob alloc] initWithAppID:HIPMOB_KEY andTitle:SUPPORTTITLE] autorelease];

iPad Chat View

		      hipmobView * supportvc = [[hipmobView alloc] initWithAppID:HIPMOB_KEY];
		      [supportvc setFrame:CGRectMake(150,50,320,245)];
		      [self.view addSubview:supportvc.view];

@interface customViewController : UIViewController<hipmobViewDelegate>

supportvc.service.delegate=self; //specifies that you will be looking for delegate methods in your view controller

-(void)willDismissHipmobView:(hipmobView *)hipmobview{
		      [supportvc release];
		      supportvc=nil;
		      }

• username
• useremail
• context
• localdeviceid
• statusmessages
• localwebview

Peer-to-Peer only

• peerdeviceid

iPad only

• orientation
• displayed

supportvc.username=USERNAME;
		      supportvc.useremail=EMAIL;
		      supportvc.localdeviceid=unique Device ID;
		      supportvc.context=@"Any information useful for the operator. For Example the screen hipmob was launched from.";

[suportvc.statusmessages setValue:NEW MESSAGE forKey:@"connecting"]

Accessing settings from the iPad hipmobView Class

supportvc.service.sername=YOUR USERNAME;
			supportvc.service.useremail=@"YOUR EMAIL";
			supportvc.service.localdeviceid=@"unique Device ID";
			supportvc.orientation = landscapeonly;

• willDismissHipmobView
• launchURL
• receivedMessageFromID

• Availability Status

[supportvc setAvailabilityStatus:NO];

hipmob *supportvc = [[[hipmob alloc] initWithAppID:@"fefed30c17f0409f89d5a4953c0fce1f"] autorelease];
		    

hipmob *supportvc = [[[hipmob alloc] initWithAppID:@"fefed30c17f0409f89d5a4953c0fce1f" andTitle:@"Support Chat"] autorelease];
		    

supportvc.localdeviceid=@"my-magical-device-identifier";

supportvc.username=@"my-magical-username";

supportvc.email=@"my-magical-email";

supportvc.context=@"my-magical-context";

[supportvc setAvailabilityStatus:FALSE];

• connecting
• connected
• disconnected
• operatoronline
• operatoroffline

[supportvc.statusmessages setValue:@"Sorry, no one is here right now. Please leave a message" forKey:@"operatoroffline"]

supportvc.localWebView=TRUE;

supportvc.peerdeviceid=YOUR_FRIEND_DEVICE_ID

if(supportvc.displayed){
		      [supportvc.view removeFromSuperView];
		      }else{
		      NSLog(@"No hipmob object being displayed");
		      }