| License | MIT |
| ReleasedLast Release | Oct 2019 |
Maintained by Luis Sanches, Britton Katnich, Rob Weber, James Go, Yasmeen Taj, Syed Yusuf, Syed Yusuf.
| Depends on: | |
| MASFoundation | = 2.0.00 |
| MASIdentityManagement | = 2.0.00 |
MASConnecta is the core messaging framework of the iOS Mobile SDK, which is part of CA Mobile API Gateway. It gives developers the ability to create social collaborative apps where users can message and send data to each other.
The MASConnecta framework comes with the following features:
Contributions are welcome and much appreciated. To learn more, see the Contribution Guidelines.
MASConnecta supports multiple methods for installing the library in a project.
To integrate MASConnecta into your Xcode project using CocoaPods, specify it in your Podfile:
source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '9.0'
pod 'MASConnecta'
Then, run the following command using the command prompt from the folder of your project:
$ pod install
For manual install, you add the Mobile SDK to your Xcode project. Note that you must add the MASFoundation library. For complete MAS functionality, install all of the MAS libraries as shown.
Copy items if needed.File->Add files to 'project name' and add the msso_config.json file from your project folder.-ObjC for Other Linker Flags.#import <MASFoundation/MASFoundation.h>
#import <MASConnecta/MASConnecta.h>
After MASConnecta is added to a project, some objects from the MASFoundation library automatically displays messaging methods. This saves you development time and makes the code cleaner. You write just a few lines of code, and the library automatically handles all of the settings for the connection to the server.
//Authenticated users have the ability to send messages (Text, Data, Image) to a user
MASUser *myUser = [MASUser currentUser];
MASUser *userB = Some user retrieved from the server
[myUser sendMessage:@"Hello World" toUser:userB completion:^(BOOL success, NSError * _Nullable error) {
NSLog(@"Message Sent : %@\nerror : %@", success ? @"YES":@"NO", error);
}];
//Authenticated users can send messages (Text, Data, Image) to a user on a specific topic
MASUser *myUser = [MASUser currentUser];
MASUser *userB = Some user retrieved from the server
//
// Get image from App Bundle
//
NSString* filePath = [[NSBundle mainBundle] pathForResource:@"image" ofType:@"jpg"];
NSData *message = [NSData dataWithContentsOfFile:filePath];
//
// Create MASMessage object
//
MASMessage *messageImage = [[MASMessage alloc] initWithPayloadData:message contentType:@"image/jpeg"];
//
// Send Message to Recipient
//
[myUser sendMessage:messageImage toUser:userB onTopic:@"vacations" completion:^(BOOL success, NSError * _Nullable error) {
NSLog(@"Message Sent : %@\nerror : %@", success ? @"YES":@"NO", error);
}];
Start listening to my messages
- (void)viewDidLoad
{
//
//Get the current authenticated user
//
MASUser *myUser = [MASUser currentUser];
//
//Listen to Messages sent to my User
//
[myUser startListeningToMyMessages:^(BOOL success, NSError *error) {
if (success) {
NSLog(@"Success subscribing to myUser topic!");
}
else {
NSLog(@"%@",error.localizedDescription);
}
}];
}
Stop listening to my messages
- (void)viewDidLoad
{
//
//Get the current authenticated user
//
MASUser *myUser = [MASUser currentUser];
//
//Stop Listening to Messages sent to my User
//
[myUser stoplisteningToMyMessages:nil];
}
Use notifications
- (void)viewDidLoad
{
[[NSNotificationCenter defaultCenter] addObserver:self
selector:@selector(didReceiveMessageNotification:)
name:MASConnectaMessageReceivedNotification
object:nil];
}- (void)didReceiveMessageNotification:(NSNotification *)notification
{
//
//Get the Message Object from the notification
//
__weak typeof(self) weakSelf = self;
dispatch_async(dispatch_get_main_queue(), ^{
MASMessage *myMessage = notification.userInfo[MASConnectaMessageKey];
[weakSelf.profileImage setImage:myMessage.payloadTypeAsImage];
[weakSelf.messagePayload setText:myMessage.payloadTypeAsString];
});
}The MASConnecta library exposes objects that let you: 1) create your own MQTTClient object 2) optionally establish connection with a host using SSL/TLS, 3) set up login and password, and 4) subscribe or publish directly to a topic.
For example:
- (void)viewDidLoad
{
[super viewDidLoad];
//
//Creating a new MQTT client
//
MASMQTTClient *client = [[MASMQTTClient alloc] initWithClientId:@"myClientID" cleanSession:YES];
//
//Connecting the mqtt client to a host
//
[client connectWithHost:@"mas.ca.com" withPort:8883 enableTLS:YES completionHandler:^(MQTTConnectionReturnCode code) {
//Your code here
}];
//
//Handling messages that arrive
//
[client setMessageHandler:^(MASMQTTMessage *message) {
//Your code here
}];
//
//Subscribing to a topic
//
[client subscribeToTopic:@"caTopic" withQos:ExactlyOnce completionHandler:^(NSArray *grantedQos) {
//Your code here
}];
//
//Publishing a message to a topic
//
[client publishString:@"Hello World" toTopic:@"caTopic" withQos:ExactlyOnce retain:YES completionHandler:^(int mid) {
//Your code here
}];
}Copyright (c) 2016 CA. All rights reserved.
This software may be modified and distributed under the terms
of the MIT license. See the LICENSE file for details.