Evalanche Module
By using the Evalanche module you can manage sending marketing emails to your users.
To use this module you have to first register at Evalanche.
Configuration
configuration key |
description |
username |
Evalanche user name of your account |
password |
Evalanche password of your account |
userId |
Evalanche user ID/mandator ID of your account |
Usage
After adding the Evalanche module to your app, you will find a class Profile in your SDK. This class represents a registered marketing email receiver in Evalanche. You can simple un-/register your users by creating or deleting a profile for them:
Android
private
void
setup() {
// create profile to register a new receiver
final
Profile profile =
new
Profile();
profile.setEmail(
"johndoe@domain.com"
);
profile.setCompany(
"My Awesome Company"
);
profile.setPoolId(
2345
);
// look into your Evalance pools, the ID can be found in the URL itself
profile.saveAsync(
new
AOMEmptyCallback() {
@Override
public
void
isDone(
boolean
wasLoadedFromStorage, ApiomatRequestException exception) {
if
(exception !=
null
) {
// You can now look into your Evalache backend and see the new receiver in you pool list
// ...
// deregister a receiver by deleting its profile:
deleteProfile(profile);
}
}
});
}
private
void
deleteProfile(
final
Profile profile) {
profile.deleteAsync(
new
AOMEmptyCallback() {
@Override
public
void
isDone(
boolean
wasLoadedFromStorage, ApiomatRequestException exception) {
if
(exception !=
null
) {
// ...
}
}
});
}
Objective-C
//create profile to register a new receiver
AOMProfile *profile = [[AOMProfile alloc] init];
[profile setEmail:@
"johndoe@domain.com"
];
[profile setCompany:@
"My Awesome Company"
];
[profile setPoolId:
2345
];
// look into your Evalance pools, the ID can be found in the URL itself
[profile saveAsyncWithBlock:^(NSError *error) {
}];
/* You can now look into your Evalache backend and see the new receiver in you pool list */
//deregister a receiver by deleting its profile:
[profile deleteAsyncWithBlock:^(NSError *error) {
}];
Swift
//create profile to register a new receiver
var profile = Profile()
profile.email =
"johndoe@domain.com"
profile.company =
"My Awesome Company"
profile.poolId =
2345
// look into your Evalance pools, the ID can be found in the URL itself
profile.save { (error) in
}
/* You can now look into your Evalache backend and see the new receiver in you pool list */
//deregister a receiver by deleting its profile:
profile.delete { (error) in
}
JavaScript
function
setup () {
var
profile =
new
Apiomat.Profile();
profile.setEmail(
"johndoe@domain.com"
);
profile.setCompany(
"My Awesome Company"
);
profile.setPoolId(2345);
// look into your Evalance pools, the ID can be found in the URL itself
var
saveCB = {
onOk :
function
() {
// You can now look into your Evalache backend and see the new receiver in you pool list
// ...
// deregister a receiver by deleting its profile:
deleteProfile(profile);
},
onError :
function
(error) {
console.log(
"Some error occured: ("
+ error.statusCode +
")"
+ error.message);
}
};
profile.save(saveCB);
}
function
deleteProfile (profile) {
var
deleteCB = {
onOk :
function
() {
// ...
},
onError :
function
(error) {
console.log(
"Some error occured: ("
+ error.statusCode +
")"
+ error.message);
}
};
profile.deleteModel(deleteCB)
}
TypeScript
const profile =
new
Profile();
profile.email =
"johndoe@domain.com"
;
profile.company =
"my company name"
;
profile.poolId(2345);
await profile.save();
// You can now look into your Evalache backend and see the new receiver in your pool list
// ...
// unregister a receiver by deleting its profile:
await profile.deleteModel();
The Evalanche module is available in all paid plans.