Context Object Reference

ctx.getApplicationInfo()

var applicationInfo = ctx.getApplicationInfo();

ctx.getAreaInfo()

var areaInfo = ctx.getAreaInfo();

ctx.getSiteConfigFragment(xpath);

var presetCropsArray = ctx.getSiteConfigFragment('/siteConfiguration/presetCrops');

/*
 presetCropsArray:
  [ "<presetCrops>
	<crop channel="Globe-Web,Globe-Print,Globe-WireNews" favorite="yes" height="719px" name="Homepage-Main" width="107px"/>
    <crop height="667px" name="iPhone 6" width="375px"/>
    <crop height="512px" name="iPad 4" width="384px"/>
   </presetCrops>" ]
*/

ctx.getCommunicationStatus()

var communicationStatus = ctx.getCommunicationStatus();

ctx.getComponentInfo()

var componentInfo = ctx.getComponentInfo();

ctx.readFile( options, callback )

var file = ctx.readFile( { 'filename': '/SysConfig/Common/Data/Sections.xml',
 'format': 'xml',
 'resolveEntities': true
});

ctx.executeQuery( settings, callback )

var settings = {
    "limit":70,
    "query":"<?xml version=\"1.0\" encoding=\"utf-8\"?><!DOCTYPE EOMSearch><EOMSearch version=\"1.0\" xmlns=\"http://EidosMedia.com/EOM/SearchEngine\" xmlns:se=\"http://EidosMedia.com/EOM/SearchEngine\" xmlns:q=\"http://EidosMedia.com/EOM/SearchEngine/query\" xmlns:qm=\"http://EidosMedia.com/EOM/SearchEngine/query/macro\" xmlns:qa=\"http://EidosMedia.com/EOM/SearchEngine/query/alias\" xmlns:qui=\"http://EidosMedia.com/EOM/SearchEngine/query/UI\" xmlns:i=\"http://EidosMedia.com/query/interpolate\"><q:Query type=\"INDEX\"><q:Properties><q:MaxResultItems value=\"70\"/><q:Sort on=\"ObjectInfo/created\" type=\"NDESCENDING\"/><q:Index name=\"@meth01_eomjse1\"/></q:Properties><q:Boolean><q:OR><se:Content q:op=\"INC\" xmlns=\"\">obama</se:Content><se:Attributes q:op=\"INC\">obama</se:Attributes></q:OR></q:Boolean></q:Query></EOMSearch>"
  }
var result = ctx.executeQuery(settings);

ctx.getUserData( filename, callback )

var friends = ctx.getUserData('friends');

ctx.addUserData( filename, data, callback )

var friends = ctx.addUserData('friends',  {
                 'fullName': 'Carroll Walke'
             });

ctx.setUserData( filename, list, callback )

var friends = ctx.setUserData('friends', [
                {
                  "fullName": "Mitchell Henson"
                },
                {
                  "fullName": "Carroll Walker"
                },
                {
                  "fullName": "Carla Sargent"
                },
                {
                  "fullName": "Sara Savage"
                },
                {
                  "fullName": "Beach Workman"
                },
                {
                  "fullName": "Courtney Roberts"
                },
                {
                  "fullName": "Abby Hood"
                },
                {
                  "fullName": "Belinda Acosta"
                }
            ]);

ctx.getContentByPath('199$/SysConfig/columnCfgCatalogs.swing.xml', { cached: true }, function(err, content) {
    if (err) {
        ctx.showError(err);
        return;
    }
    console.log(content);
});

ctx.getCurrentUser(function(err,User) {
    if (err) {
        ctx.showError(err);
        return;
    }
    // Do something with the user...
    alert(User.getName());
});

ctx.getObject('199$1.0.893734064', function(err, Obj) {
    if (err) {
        ctx.showError(err);
        return;
    }
    // Do something with the object...
    Obj.openReadonly();
});

ctx.getObjectByPath('/Globe/Stories/Test.xml', function(err, Obj) {
    if (err) {
        ctx.showError(err);
        return;
    }
    // Do something with the object...
    Obj.openReadonly();
});

var platformInfo = ctx.getPlatformInfo();

if (platformInfo.application.indexOf('Swing') > -1) {
    // Do something only if it's Swing/Swing Mobile
}

ctx.getUserByName( 'user.test1', function(err,User) {
    if (err) {
        ctx.showError(err);
        return;
    }
    // Do something with the user...
    alert(User.getName());
});

ctx.getGroupMembers( 'group.test1', function(err, members) {
    if (err) {
        ctx.showError(err);
        return;
    }
    // Do something with the user names...
    for (var i = 0; i < members.length; i++) {
        console.log(members[i]);
    }
});

ctx.openDocument( '199$1.0.893734064', function(err,User) {
    if (err) {
        ctx.showError(err);
        return;
    }

    // Document has opened correctly
});

ctx.openNewContentDialog( {
    template: '/SysConfig/Globe/Templates/poll.xml',
    contentType: 'story'
}, function(err,data) {
    if (err) {
        ctx.showError(err);
        return;
    }
    // Document has been created correctly
    alert( data.name );
});

ctx.openReadonly( '199$1.0.893734064', function(err,data) {
    if (err) {
        ctx.showError(err);
        return;
    }

    // Document has opened correctly
});

ctx.openPopupPanel( panelName );

var panelName = 'myTestPanel';
ctx.openPopupPanel( panelName );

ctx.getSelection()

var selection = ctx.getSelection();

eidosmedia.webclient.extensions.popups.register('testpopup', {
    icon: 'icon-plus',
    title: 'Custom panel title',
    containerStyle: 'background-color:red;',
    template: '/config/templates/customTemplates/testpopup.html',
    ready: function( ctx, $modal ) {
        // Popup is visible.
        console.log( ctx );

        // CUSTOM EXAMPLE
        /*
            In the footer example, we added a 'data-modal-action' to the OK button.
            We now intercept the click inside the modal.
        */

        // Add modal listeners.
        $modal.on('click', '[data-modal-action]', function( event ) {
            var action = $(this).attr('data-modal-action');
            switch(action) {
                case 'ok':
                    alert('Button clicked!');

                    // To close the modal, use $modal.modal('hide');
                    $modal.modal('hide');
                break;
            }
            event.preventDefault();
            event.stopPropagation();


        });

    }
});

ctx.getObject('199$1.0.893734064', function(err, Obj) {
    if (err) {
        ctx.showError(err);
        return;
    }
    Obj.addCollaborators(['user.3', 'user.4'], function(err, data){
        if (err) {
            ctx.showError(err);
            return;
        }
        // data is now ['user.1', 'user.2', 'user.3', 'user.4'];
        var User = ctx.getUserByName(data[0]).getInfo()
    });
});

ctx.getObject('199$1.0.893734064', function(err, Obj) {
    if (err) {
        ctx.showError(err);
        return;
    }
    // Or... Obj.executeAction({ actionId: 'postToTwitter', args: 'arguments here');
    Obj.executeAction('postToTwitter', function(err, data) {
        //.. Do something here.
    });
});

ctx.getObject('199$1.0.893734064', function(err, Obj) {
    if (err) {
        ctx.showError(err);
        return;
    }

    // Well, we already knew that...
    var objectId = Obj.getId();
});

ctx.getObject('199$1.0.893734064', function(err, Obj) {
    if (err) {
        ctx.showError(err);
        return;
    }
    Obj.getCollaborators(function(err, data){
        if (err) {
            ctx.showError(err);
            return;
        }
        // data is now ['user.1', 'user.2'];
        var User! = ctx.getUserByName(data[0]).getInfo()
    });
});

ctx.getObject('199$1.0.893734064', function(err, Obj) {
    if (err) {
        ctx.showError(err);
        return;
    }
    // Without linkName
    Obj.getCorrelations(function(err, data){
    /*
    * With linkName,
    * Obj.getCorrelations('see_also', function(err, data){
    */
        if (err) {
            ctx.showError(err);
            return;
        }

        // data is an array of Objects
        for (var j = 0; j < data.length; j++) {
            console.log(data.getName());
        }
    });
});

ctx.getObject('199$1.0.893734064', function(err, Obj) {
    if (err) {
        ctx.showError(err);
        return;
    }

    var objInfo = Obj.getInfo();
    // Obj info is now a JSON containing all the information.
});

    var container = ctx.activeObject.getContainer();
    // container is an Object Class instance.
});

ctx.getObject('199$1.0.893734064', function(err, Obj) {
    if (err) {
        ctx.showError(err);
        return;
    }
    Obj.getLinks(function(err, links){
        if (err) {
            ctx.showError(err);
            return;
        }
        // Each link is an Object Class instance.
        // So, it is possible to do so.
        for (var j = 0, ln = links.length; j < ln; j++) {
            console.log( links[j].getLocker() );
        }
    });
});

ctx.getObject('199$1.0.893734064', function(err, Obj) {
    if (err) {
        ctx.showError(err);
        return;
    }
    Obj.getZones({includeLinks: true}, function(err, zones){
        if (err) {
            ctx.showError(err);
            return;
        }
        // Each link is an Object Class instance.
        // So, it is possible to do so.
        for (var j = 0, ln = zones.length; j < ln; j++) {
            console.log( zones[j].getInfo() );

            var links = zones[j].getLinks();

            for (var z = 0, ll = zones.length; z < ll; z++) {
                console.log( links[z].getInfo() );
            }
        }
    });
});

ctx.getObject('199$1.0.893734064', function(err, Obj) {
    if (err) {
        ctx.showError(err);
        return;
    }
    var lockerBy = Obj.getLocker();
});

ctx.getObject('199$1.0.893734064', function(err, Obj) {
    if (err) {
        ctx.showError(err);
        return;
    }
    var objMetadata = Obj.getMetadata();
    var $objMetadata = $.parseXML(objMetadata);
});

ctx.getObject('199$1.0.893734064', function(err, Obj) {
    if (err) {
        ctx.showError(err);
        return;
    }
    var name = Obj.getName();
});

ctx.getObject('199$1.0.893734064', function(err, Obj) {
    if (err) {
        ctx.showError(err);
        return;
    }
    var statusInfo = Obj.getStatusInfo();
    // Now
    // statusInfo.name is the status name
    // statusInfo.comment
    // statusInfo.identifier is the RGB color
});

ctx.getObject('199$1.0.893734064', function(err, Obj) {
    if (err) {
        ctx.showError(err);
        return;
    }
    var objSysAttr = Obj.getSystemAttributes();
    var $sysAttr = $.parseXML(objSysAttr);
});

ctx.getObject('199$1.0.893734064', function(err, Obj) {
    if (err) {
        ctx.showError(err);
        return;
    }
    var type = Obj.getType();
});

ctx.getObject('199$1.0.893734064', function(err, Obj) {
    if (err) {
        ctx.showError(err);
        return;
    }
    var type = Obj.isType('EOM::Story');
});

ctx.getObject('199$1.0.893734064', function(err, Obj) {
    if (err) {
        ctx.showError(err);
        return;
    }
    var usageTicket = Obj.getUsageTicket();
    var $usageTicket = $.parseXML(usageTicket);
});

ctx.getObject('199$1.0.893734064', function(err, Obj) {
    if (err) {
        ctx.showError(err);
        return;
    }
    Obj.getRoles({roleType: 'EOM::WebContainerLinks', roleName: '1.0.232702264'}, function(err, role){
        if (err) {
            ctx.showError(err);
            return;
        }
        console.log(role);
    });
});

ctx.getObject('199$1.0.893734064', function(err, Obj) {
    if (err) {
        ctx.showError(err);
        return;
    }
    var virtualAttributes = Obj.getVirtualAttributes();
    var $virtualAttributes = $.parseXML(virtualAttributes);
});

ctx.getObject('199$1.0.893734064', function(err, Obj) {
    if (err) {
        ctx.showError(err);
        return;
    }
    Obj.open(function(err, data) {
        // Callback after the document is opened
    });
});

ctx.getObject('199$1.0.893734064', function(err, Obj) {
    if (err) {
        ctx.showError(err);
        return;
    }
    Obj.lock(function(err, data) {
        // Callback after the document is locked
    });
});

ctx.getObject('199$1.0.893734064', function(err, Obj) {
    if (err) {
        ctx.showError(err);
        return;
    }
    Obj.unlock(function(err, data) {
        // Callback after the document is unlocked
    });
});

ctx.getObject('199$1.0.893734064', function(err, Obj) {
    if (err) {
        ctx.showError(err);
        return;
    }
    Obj.openReadonly(function(err, data) {
        // Callback after the document is opened
    });
});

ctx.getObject('199$1.0.893734064', function(err, Obj) {
    if (err) {
        ctx.showError(err);
        return;
    }

    // Register to all the events.
    Obj.registerToEvents(function(eventName, data) {
        // eventName contains the name of the event
        // "unlock", "lock", "check in"...
        // data contains the information regarding the event.

        // Eventually, if needed, call a refresh for the object.

        Obj.refresh().getLocker();

    });


});

ctx.getObject('199$1.0.893734064', function(err, Obj) {
    if (err) {
        ctx.showError(err);
        return;
    }

    // Perform very complex operations
    // Such as saving the document or setting the document metadata

    // To obtain the new metadata... do this.
    Obj = Obj.refresh();
    Obj.getMetadata();
});

ctx.getObject('199$1.0.893734064', function(err, Obj) {
    if (err) {
        ctx.showError(err);
        return;
    }
    Obj.removeCollaborators(['user.1'], function(err, data){
        if (err) {
            ctx.showError(err);
            return;
        }
        // data is now ['user.1'];
        var User = ctx.getUserByName(data[0]).getInfo()
    });
});

ctx.getObject('199$1.0.893734064', function(err, Obj) {
    if (err) {
        ctx.showError(err);
        return;
    }

    var request = { xpath: '/ObjectMetadata/General/Priority', content: 'High title'};
    // Or an array
    // var request = [ { xpath: '/ObjectMetadata/General/Priority', content: 'High title'},
                        { xpath: '/ObjectMetadata/General/Priority2', content: 'High title2'}
                        { xpath: '/ObjectMetadata/General/Priority3', content: 'High title3'} ];
    Obj.setMetadata(request, function(err, data) {
        if (err) {
            ctx.showError(err);
            return;
        }
        // Success...
    });
});

ctx.getObject('199$1.0.893734064', function(err, Obj) {
    if (err) {
        ctx.showError(err);
        return;
    }

    Obj.setStatus('NewsFlow/Editing', function(err, data) {
        if (err) {
            ctx.showError(err);
            return;
        }
        // Success...
    });
});

ctx.getObject('199$1.0.893734064', function(err, Obj) {
    if (err) {
        ctx.showError(err);
        return;
    }

    var request = { xpath: '/props/title/', content: 'High title'};
    // Or an array
    // var request = [ { xpath: '/props/title/', content: 'High title'},
                        { xpath: '/props/summary/', content: 'Summary'} ];
    Obj.setSystemAttributes(request, function(err, data) {
        if (err) {
            ctx.showError(err);
            return;
        }
        // Success...
    });
});

ctx.getObject('199$1.0.893734064', function(err, Obj) {
    if (err) {
        ctx.showError(err);
        return;
    }

    Obj.cleanMetadataField('/ObjectMetadata/General/Priority', function(err, data) {
        if (err) {
            ctx.showError(err);
            return;
        }
        // Success...
    });
});

[
  {
    "id": "99$1.0.287059148",
    "name": "Obama.xml",
    "baseName": "Obama",
    "path": "/Globe/Stories/Globe/Stories/Politics/2019-03-18/Politics/Obama.xml",
    "channel": "Globe-Web",
    "edition": null,
    "section": null,
    "issueDate": "20190318",
    "subFolder": null,
    "workFolder": "/Globe/Politics",
    "channelIdentifier": "Globe-Web"
  },
  {
    "id": "99$1.0.287059376",
    "name": "Obama@Globe-Print-USA.xml",
    "baseName": "Obama@Globe-Print-USA",
    "path": "/Globe/Stories/Globe/Stories/Politics/2019-03-18/Politics/Obama.xml/Obama@Globe-Print-USA.xml",
    "channel": "Globe-Print",
    "edition": "USA",
    "section": null,
    "issueDate": "20190318",
    "subFolder": null,
    "workFolder": "/Globe/Politics",
    "channelIdentifier": "Globe-Print/USA"
  }
]

ctx.activeObject.getBundleInfo(function(err, list) {
    if (err) {
        ctx.showError(err);
        return;
    }
    //Success
});

[
    {
        "id": "41$1.0.107332121",
        "channel": null,
        "info": {
            "id": "41$1.0.107332121",
            "name": "story.xml",
            "baseName": "story",
            "path": "/Globe/Stories/Art/story.xml",
            "channel": null,
            "edition": null,
            "section": null,
            "issueDate": "20190111",
            "subFolder": null,
            "workFolder": "/Globe/Art",
            "channelIdentifier": "none"
        },
        "master": true
    },
    {
        "id": "41$1.0.107314527",
        "channel": "Globe-Print",
        "info": {
            "id": "41$1.0.107314527",
            "name": "story@Globe-Print.xml",
            "baseName": "story@Globe-Print",
            "path": "/Globe/Stories/Art/story.xml/story@Globe-Print.xml",
            "channel": "Globe-Print",
            "edition": null,
            "section": null,
            "issueDate": "20190111",
            "subFolder": null,
            "workFolder": "/Globe/Art",
            "channelIdentifier": "Globe-Print"
        }
    }
]

ctx.activeObject.getChannelCopiesList(function(err, list) {
    if (err) {
        ctx.showError(err);
        return;
    }
    //Success
});

ctx.activeObject.createChannelCopy('Product/Edition', function(err) {
    if (err) {
        ctx.showError(err);
        return;
    }
    //Success
});

ctx.getCurrentUser(function(err,User) {
    var groups = User.getGroups();
    console.log(teams);
});

{
  "name": "john.doe",
  "description": "Star Software",
  "ucount": 13159,
  "databaseId": 199,
  "id": "1.0.532488046",
  "fullName": "John Doe",
  "phoneNumber": "(01) 5748584456)",
  "mobileNumber": "(001) 5476987496798)",
  "twitter": "johndoe",
  "role": "Reporter",
  "homeEmail": "john.doe@google.com",
  "businessEmail": "john.doe@star.com",
  "statusMessage": "I am available",
  "workDir": "workFolder:///Globe/Art",
  "location": "London",
  "lastLoggedOn": 1494418598,
  "initials": "JD",
  "signature": "john doe",
  "homePath": "/Users/john.doe",
  "calendars": [
    {
      "color": "#32AE0C",
      "id": "U12001806763ERC",
      "name": "UK Holidays",
      "url": "https://www.gov.uk/england-and-wales.ics",
      "icon": "icon-calendar",
      "private": false
    }
  ],
  "status": "busy",
  "disabled": false
}

ctx.getCurrentUser(function(err,User) {
    var userInfo = User.getInfo();
    // Or, if you prefer,
    User.getInfo(function(err, userInfo){
        console.log(userInfo.name);
    });
});

ctx.getCurrentUser(function(err,User) {
    var metadata = User.getMetadata();
    console.log(metadata);
});

ctx.getCurrentUser(function(err,User) {
    var userName = User.getName();
    console.log(userName);
});

ctx.getCurrentUser(function(err,User) {
    var systemAttributesXml = User.getSystemAttributes();
    var $sysAttr = $.parseXML(systemAttributesXml);
    console.log(systemAttributesXml);
});

ctx.getCurrentUser(function(err,User) {
    var teams = User.getTeams();
    console.log(teams);
});

ctx.getCurrentUser(function(err,User) {
    var systemAttributes = '<props><principalInfo><email type="business">johndoe@star.comw</email><initials>JD</initials><signature>john doe</signature><statusMessage>I am available</statusMessage><color type="revision" value="#008080"/><color type="annotation" value="#800000"/><location>London</location><email type="home">johndoe@google.com</email><twitter>johndoe</twitter><facebook>aaaa</facebook><mobileNumber>(01) 7834684587438</mobileNumber><phoneNumber>(001) 54753754765375</phoneNumber><status>busy</status><workDir>workFolder:///Globe/Art</workDir><calendar><id>U12001806763ERC</id><icon>icon-calendar</icon><color>#32AE0C</color><name>UK Holidays</name><url>https://www.gov.uk/bank-holidays/england-and-wales.ics</url><private>false</private></calendar></principalInfo><role>Reporter</role><OutputChannels><channel name="Globe-Print"/></OutputChannels></props>';

    User.setSystemAttributes(systemAttributes, function(err, data) {
        if (err) {
            // Do something...
            return;
        }
    );

});

ctx.getCurrentUser(function(err,User) {
    var attributes = '<test><secondtest>hello</secondtest></test>';

    User.setMetadata(attributes, function(err, data) {
        if (err) {
            // Do something...
            return;
        }
    );

});