API for opened document URL

Axadiw

Hi,

Is it possible to gain an access to the URL of the currently opened .sketch file?

Cheers

robin

context.document.fileURL() will give you an NSURL

works because MSDocument is a subclass of NSDocument

ale

Try context.document.fileURL()

Axadiw

And is it possible to get this URL even when I'm not able to get current document?

For example in "OpenDocument" Action, context that is passed from Sketch doesn't contain document:

{
    action = OpenDocument;
    actionContext =     {
    };
    api = "<MOJavaScriptObject: 0x618000233ec0>";
    command = "<MSPluginCommand: 0x6080002e7880>";
    plugin = "<MSPluginBundle: 0x6100000ff880>";
    scriptPath = "<path_to_script>";
    scriptURL = "<path_to_script>";
}

ale

Axadiw that's currently not possible at the moment, because you've uncovered a bug in the Action API. The OpenDocument event is triggered right before the document is actually opened, and so you cannot access it from the event. I've filed a bug report and we're working to get that fixed.

RabbitOriginalFlavor

ale how is it going with this bug fixing? Cause I need the file url once it's loaded into sketch for my plugin.

Axadiw

Great, I'm waiting for the fix than ?

So far I've hacked this by using mixture of coscript.scheduleWithInterval_jsFunction(interval,function() and MSDocument.currentDocument(), but recieving current document in the context would be much better.

d4rek

Hello, I'm trying context.document.fileURL() but got (null) instead of a NSURL object, am I missing something?

d4rek

d4rek ahhh nevermind I was testing it on an unsaved document!

ale

RabbitOriginalFlavor this was fixed in Sketch 43

RabbitOriginalFlavor

ale

When I use context.document.fileURL() I get null exception because there is no document attribute in this context. Yet when I use context.actionContext.document.fileURL() I get a null URL object. My sketch is 45 so what is the solution to this? Thanks.

pieter

Indeed the document property can be accessed via the actionContext. However if the document has not yet been saved to disk the fileURL will return nil. That is expected behaviour. Could that be what's happening for you?

RabbitOriginalFlavor

pieter I tested on files already saved in the disk so I guess that's not my case.

pieter

Turns out you were right all along. Our apologies. This did not get fixed in v43. OpenDocument was called in MSDocument's -init method, which is too early for any of the UI to be set up or the fileURL to have been set. I'll see if we can call it at a later date in the setup of a document.

Lnsx

Was this ever fixed? I think I'm getting the same issue with the url being null at OpenDocument but being available on SelectionChanged.

romansp

Seems that's still an issue in Sketch 47.1. I was trying to access actionContext.document.artboards() or actionContext.document.hasArtboards() but it always returns empty array and false respectively.

Is there any other way to determine if document has any artboards, just after document was initally opened?

Registering function via coscript.scheduleWithInterval_jsFunction doesn't seem to work inside an action handler, but handler isn't called at all.

romansp

Oh my, forgot to specifyCOScript.currentCOScript().setShouldKeepAround(true). After doing so got it working like this:

COScript.currentCOScript().setShouldKeepAround(true);
COScript.currentCOScript().scheduleWithInterval_jsFunction(0, function() => {
  var hasArtboards = context.actionContext.document.hasArtboards();
})

arblackman

Is there any update on this?
I really need to track both OpenDocument and CloseDocument within my plugin, and even in Sketch v58 I'm not seeing the opened or closed document being populated in the actionContext.

kevgski

Not sure I follow @arblackman, I get this list of actions triggered when I open a new document

NewLocalDocument.begin
OpenDocument
HandlerGotFocus
ToggleRulers.begin
ToggleRulers.finish
NewLocalDocument.finish
SelectionChanged.begin
SelectionChanged.finish
HandlerLostFocus
HandlerGotFocus

likewise when I close the document, these actions get triggered

CloseDocument

Are you not able to hook into the Open and CloseDocument actions?

robin

kevgski I don't think the problem is that the actions aren't firing, it's about the actionContext not containing the corresponding document

I made a tiny test plugin and the context seems to contain the document
manifest.json

{
  "author" : "",
  "commands" : [
    {
      "script" : "script.js",
      "handlers" : {
        "actions" : {
          "OpenDocument":"onOpenDocument"
        }
      }
    }
  ],
  "menu" : {
    "title" : "opendoc",
    "items" : [
      "com.bohemiancoding.sketch.runscriptidentifier"
    ]
  },
  "identifier" : "com.example.sketch.c0e6fa79-c868-4537-9b3b-a991789efdb5",
  "version" : "1.0",
  "description" : "",
  "authorEmail" : "",
  "name" : "opendoc"
}

script.js

function onOpenDocument(context){
  log(context.actionContext);
}

is printing

{
    document = "<MSDocument: 0x7fc15199fd40>";
    selection =     (
    );
}

when I'm opening a document.

Can you test this code to check it's not some other issue? @arblackman