Help :- Alfresco API and Documentation in Detail

[nirvanvjain]

Dear All,

While Exploring Alfresco Share, I found these URLs or APIs.

Alfresco.util.encodeHTML

Alfresco.constants.PROXY_URI_RELATIVE

Alfresco.Search.superclass.constructor.call

Alfresco.Search

Alfresco.component.Base

Alfresco.util.createYUIButton :- Extension of YUI API (Where is the DocS for this API)

Alfresco.util.NodeRef

Alfresco.util.PopupManager.displayPrompt

Alfresco.util.PopupManager.displayMessage

Alfresco.constants.URL_RESCONTEXT

Alfresco.constants.URL_RESCONTEXT

Alfresco.util.RENDERLOOPSIZE

Alfresco.constants.URL_PAGECONTEXT

Alfresco.util.message

Please Guide me in these

Thanks!
-Nirvan

[mikeh]

Most of those are in the alfresco.js client-side JavaScript file. Take a look in there for per-function documentation. Note: you'll have to look at alfresco.js not alfresco-min.js

Thanks,
Mike

[nirvanvjain]

Dear MikeH,

Thanks for your quick reply.

I have also gone through that alfresco.js file but still have a lots of quest.

Please give some idea in depth.

Appreciate your help.

Thanks!
-Nirvan

[mikeh]

I have also gone through that alfresco.js file but still have a lots of quest.

Please give some idea in depth.

Other than give you a line-by-line description of the source code (which, sorry, but I am not going to do) this question is too open-ended to be useful.

Is there something specific you're stuck with? Have you looked at how we use those functions ourselves within Share? What extra documentation do you think those functions need?

Thanks,
Mike

[nirvanvjain]

Dear Mike,

Precisely, thats where I am stuck..!!! how we use those functions ourselves within Share?

As I mentioned above there are some syntaxs like :-

Alfresco.constants.URL_RESCONTEXT

Alfresco.constants.PROXY_URI_RELATIVE

Alfresco.util.encodeHTML

Alfresco.Search

Alfresco.Search.superclass.constructor.call


In alfresco.js these functions are used but how these work ? What are the Use of them, What they do?

This help is expected from your sir.

Thanks!
-Nirvan

[mikeh]

Is there something specific you're stuck with? Have you looked at how we use those functions ourselves within Share? What extra documentation do you think those functions need?

I think you mis-read this. Particularly: Have you looked at how we use those functions ourselves within Share?

[afaust]

Hello,

although Mike beat me to the punch on this, I have to ask: Aren't the names of the function you've listed self-explanatory? I mean, what does "encodeHTML" do? Of course encode a given text as HTML. "Alfresco.Search.superclass.constructor.call" is nothing which is really Alfresco-specific, just related to how JavaScript-OOP is handled. And the purpose of the constants can be derived by looking at their values using something like FireBug.

Regards
Axel

[nirvanvjain]

Is there something specific you're stuck with? Have you looked at how we use those functions ourselves within Share? What extra documentation do you think those functions need?

I think you mis-read this. Particularly: Have you looked at how we use those functions ourselves within Share?

Dear Mike,

I am sure that I haven't mis-read your above posts. I really can't understand how these methods are being used in our other components JavaScripts ?

@AFaust » I think you can also add your valuable knowledge here. Before your replied my last post I got that those are constants which are used in many JS files but my doubt how these functions are used in other component JS?

Appreciate your help.

Thanks~!
-Nirvan

[mikeh]

I think we're going round in circles here.

If there's a specific problem you're trying to solve, please let us know. However, "How does most of the (open) source code work?" I"m afraid is much too generic to answer usefully here.

Thanks,
Mike

[nirvanvjain]

Dear MikeH , AFaust and Alfresco Team,

I want to reuse Alfresco Create Event functionality (which is in Calendar Add Event) [{ Not Entire Create Event Pop Up Functionality but Just Start Date and End Date ones }].

I want to reuse it in Upload Pop-Up. I am able to reuse the calender create event (Add Event)'s Start Date and End Date Function in flash-upload-min.js file.

In side that,there is one function named Alfresco.util.formatDate(x,y,..). After some what R & D, I came to know about some functions which are used from alfresco.js as per your above guidelines.

Now in other javascript files (such as search-min.js etc) where this Alfresco.util.formatDate(x,y,..) used inside bacause it automatically imports (gets reference of ) alfresco.js but in flash-upload.js file , it is not getting  (Using) that alfresco.js , so How Alfresco Share uses automatically (adding ) in its some of the out of box functionality or say how Can I be able to add (import) that alfresco.js ( or Alfresco Share javascript API) File(s) in my custom javascript files?

I guess its much descriptive and detailed.

Please guide me to move ahead.

Thanks!
-Nirvan Jain