More in this section

Forums / Developing with Sitefinity / API reference?

API reference?

11 posts, 0 answered
  1. Tanya
    Tanya avatar
    17 posts
    Registered:
    10 Feb 2012
    23 Feb 2012
    Link to this post
    Hi,
    This may be a dumb question, but I can't seem to find the answer anywhere. Is there an online API reference for Sitefinity 4 similar to the one that exists for 3? It seems there used to be coverage in the old 4.0 developers guide which is no longer on the site.

    Otherwise any way to get this documentation? We have tried installing the SDK, and currently have a support ticket in to do so, but we are encountering errors.

    thanks
    Tanya
  2. SelAromDotNet
    SelAromDotNet avatar
    912 posts
    Registered:
    18 Jul 2012
    24 Feb 2012
    Link to this post
    Tanya,

    Because of the shift to using Sitefinity for Documentation, the API reference is no longer compiled automatically and uploaded online. Instead it will now be distributed with the Sitefinity SDK.

    I hope this is helpful!
  3. olav
    olav avatar
    76 posts
    Registered:
    22 Jan 2007
    27 Apr 2012
    Link to this post
    Hi,

    I'm sure that Sitefinity for Documentation could be great, but I'm also having a hard time accessing some kind of Sitefinity API reference. Preferably something like the MDSN Library, having short samples and cross references.

    I finally accepted to use local help for VS2010, to be able to install the SF API reference from the SDK (5.0.2500.7), but each page has a red text like this in the top:
    [Missing <summary> documentation for "N:Telerik.Sitefinity"]
    I guess this particular CHM build had an issue.

    Online API is better for communication.
    Right?
  4. olav
    olav avatar
    76 posts
    Registered:
    22 Jan 2007
    27 Apr 2012
    Link to this post
    Aw, I get lots of errors on your web these days, causing me to double post.
    ....................
  5. Chris
    Chris avatar
    1 posts
    Registered:
    26 Apr 2012
    21 May 2012
    Link to this post
    olav,
    I am seeing this too. I also would like to see an online version similar to MSDN!
  6. Talin
    Talin avatar
    2 posts
    Registered:
    25 Jun 2012
    09 Jul 2012
    Link to this post
    Yes, would love to see something similar to MSDN.

    Meanwhile, I've downloaded the Sitefinity SDK and I still can't seem to access an API Reference. In the Sitefinity SDK Browser app, under the Documentation tab, the API Reference option for 'Open the local file' is greyed out and disabled. The 'Read online' link is active but takes me to http://www.sitefinity.com/documentation/documentationarticles/developers-guide which doesn't have an API reference...

    Does anyone know where to look?

    Thanks!
  7. SelAromDotNet
    SelAromDotNet avatar
    912 posts
    Registered:
    18 Jul 2012
    09 Jul 2012
    Link to this post
    Talin,

    For instructions on installing the API Reference for Sitefinity, please take a look at this blog post: How to view the Sitefinity API Reference in Visual Studio 2010

    I apologize that this isn't more clear, and I will relay this feedback to the SDK team so we can try to update the info in the SDK browser for the next release!
  8. Talin
    Talin avatar
    2 posts
    Registered:
    25 Jun 2012
    10 Jul 2012
    Link to this post
    Hi SelAromDotNet,

    Thanks for your reply. The post is very informative, but I don't see the “Install_Sitefinity API Reference.bat" file mentioned.

    I'm running a trial version of Sitefinity, could that be the cause?

    Thanks,
    Joe
  9. SelAromDotNet
    SelAromDotNet avatar
    912 posts
    Registered:
    18 Jul 2012
    10 Jul 2012
    Link to this post
    Joe,
    The API reference is included with the Sitefinity SDK. It can be installed alongside the trial project manager and you can reuse your trial license for the samples too if you wish.

    hope this is helpful!
  10. Joe
    Joe avatar
    1 posts
    Registered:
    25 Jul 2012
    27 Jul 2012
    Link to this post
    Hi SelAromDotNet,

    Thanks for the link to the blog. I don't see the “Install_Sitefinity API Reference.bat” file in C:\Program Files (x86)\Telerik\Sitefinity 5.0\SDK (the attached screenshot shows the contents of the folder). I'm at a bit of a loss for what to try next... Do you have any suggestions?

    Thanks!

    Joe
  11. Victor Velev
    Victor Velev avatar
    1345 posts
    Registered:
    06 Jul 2015
    30 Jul 2012
    Link to this post
    Hi,

    You can find the bat files in:

    C:\Program Files (x86)\Telerik\Sitefinity 5.0\SDK\Content\Documents\Chm


    assuming that you have a 64bit machine. If you are on 32bit the following directory folder should be valid:

    C:\Program Files\Telerik\Sitefinity 5.0\SDK\Content\Documents\Chm

    I have attached a screenshot as well.

    Greetings,
    Victor Velev
    the Telerik team
    Do you want to have your say in the Sitefinity development roadmap? Do you want to know when a feature you requested is added or when a bug fixed? Explore the Telerik Public Issue Tracking system and vote to affect the priority of the items
11 posts, 0 answered